diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 419e13d..affc77b 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -20,4 +20,4 @@ After the initial reply to your report, the security team will keep you informed ## Security Alerts -We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/DS4SD/docling/discussions/categories/announcements). +We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/docling-project/docling/discussions/categories/announcements). diff --git a/.github/workflows/ci-images-dryrun.yml b/.github/workflows/ci-images-dryrun.yml index 606beee..8c36744 100644 --- a/.github/workflows/ci-images-dryrun.yml +++ b/.github/workflows/ci-images-dryrun.yml @@ -13,15 +13,15 @@ jobs: strategy: matrix: spec: - - name: ds4sd/docling-serve + - name: docling-project/docling-serve build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cu124 --no-extra cpu platforms: linux/amd64, linux/arm64 - - name: ds4sd/docling-serve-cpu + - name: docling-project/docling-serve-cpu build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cu124 platforms: linux/amd64, linux/arm64 - - name: ds4sd/docling-serve-cu124 + - name: docling-project/docling-serve-cu124 build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cpu platforms: linux/amd64 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0a90aea..bcb2a35 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,7 +8,7 @@ on: jobs: code-checks: - # if: ${{ github.event_name == 'push' || (github.event.pull_request.head.repo.full_name != 'DS4SD/docling-serve' && github.event.pull_request.head.repo.full_name != 'ds4sd/docling-serve') }} + # if: ${{ github.event_name == 'push' || (github.event.pull_request.head.repo.full_name != 'docling-project/docling-serve' && github.event.pull_request.head.repo.full_name != 'docling-project/docling-serve') }} uses: ./.github/workflows/job-checks.yml permissions: packages: write diff --git a/.github/workflows/images.yml b/.github/workflows/images.yml index d0c4832..00ac40e 100644 --- a/.github/workflows/images.yml +++ b/.github/workflows/images.yml @@ -17,15 +17,15 @@ jobs: strategy: matrix: spec: - - name: ds4sd/docling-serve + - name: docling-project/docling-serve build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cu124 --no-extra cpu platforms: linux/amd64, linux/arm64 - - name: ds4sd/docling-serve-cpu + - name: docling-project/docling-serve-cpu build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cu124 platforms: linux/amd64, linux/arm64 - - name: ds4sd/docling-serve-cu124 + - name: docling-project/docling-serve-cu124 build_args: | UV_SYNC_EXTRA_ARGS=--no-extra cpu platforms: linux/amd64 diff --git a/CHANGELOG.md b/CHANGELOG.md index b47730b..cb29acb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,36 +1,36 @@ -## [v0.5.1](https://github.com/DS4SD/docling-serve/releases/tag/v0.5.1) - 2025-03-10 +## [v0.5.1](https://github.com/docling-project/docling-serve/releases/tag/v0.5.1) - 2025-03-10 ### Fix -* Submodules in wheels ([#85](https://github.com/DS4SD/docling-serve/issues/85)) ([`a92ad48`](https://github.com/DS4SD/docling-serve/commit/a92ad48b287bfcb134011dc0fc3f91ee04e067ee)) +* Submodules in wheels ([#85](https://github.com/docling-project/docling-serve/issues/85)) ([`a92ad48`](https://github.com/docling-project/docling-serve/commit/a92ad48b287bfcb134011dc0fc3f91ee04e067ee)) -## [v0.5.0](https://github.com/DS4SD/docling-serve/releases/tag/v0.5.0) - 2025-03-07 +## [v0.5.0](https://github.com/docling-project/docling-serve/releases/tag/v0.5.0) - 2025-03-07 ### Feature -* Async api ([#60](https://github.com/DS4SD/docling-serve/issues/60)) ([`82f8900`](https://github.com/DS4SD/docling-serve/commit/82f890019745859699c1b01f9ccfb64cb7e37906)) -* Display version in fastapi docs ([#78](https://github.com/DS4SD/docling-serve/issues/78)) ([`ed851c9`](https://github.com/DS4SD/docling-serve/commit/ed851c95fee5f59305ddc3dcd5c09efce618470b)) +* Async api ([#60](https://github.com/docling-project/docling-serve/issues/60)) ([`82f8900`](https://github.com/docling-project/docling-serve/commit/82f890019745859699c1b01f9ccfb64cb7e37906)) +* Display version in fastapi docs ([#78](https://github.com/docling-project/docling-serve/issues/78)) ([`ed851c9`](https://github.com/docling-project/docling-serve/commit/ed851c95fee5f59305ddc3dcd5c09efce618470b)) ### Fix -* Remove uv from image, merge ARG and ENV declarations ([#57](https://github.com/DS4SD/docling-serve/issues/57)) ([`c95db36`](https://github.com/DS4SD/docling-serve/commit/c95db3643807a4dfb96d93c8e10d6eb486c49a30)) -* **docs:** Remove comma in convert/source curl example ([#73](https://github.com/DS4SD/docling-serve/issues/73)) ([`05df073`](https://github.com/DS4SD/docling-serve/commit/05df0735d35a589bdc2a11fcdd764a10f700cb6f)) +* Remove uv from image, merge ARG and ENV declarations ([#57](https://github.com/docling-project/docling-serve/issues/57)) ([`c95db36`](https://github.com/docling-project/docling-serve/commit/c95db3643807a4dfb96d93c8e10d6eb486c49a30)) +* **docs:** Remove comma in convert/source curl example ([#73](https://github.com/docling-project/docling-serve/issues/73)) ([`05df073`](https://github.com/docling-project/docling-serve/commit/05df0735d35a589bdc2a11fcdd764a10f700cb6f)) -## [v0.4.0](https://github.com/DS4SD/docling-serve/releases/tag/v0.4.0) - 2025-02-26 +## [v0.4.0](https://github.com/docling-project/docling-serve/releases/tag/v0.4.0) - 2025-02-26 ### Feature -* New container images ([#68](https://github.com/DS4SD/docling-serve/issues/68)) ([`7e6d9cd`](https://github.com/DS4SD/docling-serve/commit/7e6d9cdef398df70a5b4d626aeb523c428c10d56)) -* Render DoclingDocument with npm docling-components in the example UI ([#65](https://github.com/DS4SD/docling-serve/issues/65)) ([`c430d9b`](https://github.com/DS4SD/docling-serve/commit/c430d9b1a162ab29104d86ebaa1ac5a5488b1f09)) +* New container images ([#68](https://github.com/docling-project/docling-serve/issues/68)) ([`7e6d9cd`](https://github.com/docling-project/docling-serve/commit/7e6d9cdef398df70a5b4d626aeb523c428c10d56)) +* Render DoclingDocument with npm docling-components in the example UI ([#65](https://github.com/docling-project/docling-serve/issues/65)) ([`c430d9b`](https://github.com/docling-project/docling-serve/commit/c430d9b1a162ab29104d86ebaa1ac5a5488b1f09)) -## [v0.3.0](https://github.com/DS4SD/docling-serve/releases/tag/v0.3.0) - 2025-02-19 +## [v0.3.0](https://github.com/docling-project/docling-serve/releases/tag/v0.3.0) - 2025-02-19 ### Feature -* Add new docling-serve cli ([#50](https://github.com/DS4SD/docling-serve/issues/50)) ([`ec33a61`](https://github.com/DS4SD/docling-serve/commit/ec33a61faa7846b9b7998fbf557ebe39a3b800f6)) +* Add new docling-serve cli ([#50](https://github.com/docling-project/docling-serve/issues/50)) ([`ec33a61`](https://github.com/docling-project/docling-serve/commit/ec33a61faa7846b9b7998fbf557ebe39a3b800f6)) ### Fix -* Set DOCLING_SERVE_ARTIFACTS_PATH in images ([#53](https://github.com/DS4SD/docling-serve/issues/53)) ([`4877248`](https://github.com/DS4SD/docling-serve/commit/487724836896576ca4f98e84abf15fd1c383bec8)) -* Set root UI path when behind proxy ([#38](https://github.com/DS4SD/docling-serve/issues/38)) ([`c64a450`](https://github.com/DS4SD/docling-serve/commit/c64a450bf9ba9947ab180e92bef2763ff710b210)) -* Support python 3.13 and docling updates and switch to uv ([#48](https://github.com/DS4SD/docling-serve/issues/48)) ([`ae3b490`](https://github.com/DS4SD/docling-serve/commit/ae3b4906f1c0829b1331ea491f3518741cabff71)) +* Set DOCLING_SERVE_ARTIFACTS_PATH in images ([#53](https://github.com/docling-project/docling-serve/issues/53)) ([`4877248`](https://github.com/docling-project/docling-serve/commit/487724836896576ca4f98e84abf15fd1c383bec8)) +* Set root UI path when behind proxy ([#38](https://github.com/docling-project/docling-serve/issues/38)) ([`c64a450`](https://github.com/docling-project/docling-serve/commit/c64a450bf9ba9947ab180e92bef2763ff710b210)) +* Support python 3.13 and docling updates and switch to uv ([#48](https://github.com/docling-project/docling-serve/issues/48)) ([`ae3b490`](https://github.com/docling-project/docling-serve/commit/ae3b4906f1c0829b1331ea491f3518741cabff71)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7a137b..e1dd11d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,13 @@ Our project welcomes external contributions. If you have an itch, please feel free to scratch it. -To contribute code or documentation, please submit a [pull request](https://github.com/DS4SD/docling-serve/pulls). +To contribute code or documentation, please submit a [pull request](https://github.com/docling-project/docling-serve/pulls). A good way to familiarize yourself with the codebase and contribution process is -to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/DS4SD/docling-serve/issues). +to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/docling-project/docling-serve/issues). Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us. -For general questions or support requests, please refer to the [discussion section](https://github.com/DS4SD/docling-serve/discussions). +For general questions or support requests, please refer to the [discussion section](https://github.com/docling-project/docling-serve/discussions). **Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or @@ -17,14 +17,14 @@ cannot be accepted at all!** ### Proposing new features -If you would like to implement a new feature, please [raise an issue](https://github.com/DS4SD/docling-serve/issues) +If you would like to implement a new feature, please [raise an issue](https://github.com/docling-project/docling-serve/issues) before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base. ### Fixing bugs -If you would like to fix a bug, please [raise an issue](https://github.com/DS4SD/docling-serve/issues) before sending a +If you would like to fix a bug, please [raise an issue](https://github.com/docling-project/docling-serve/issues) before sending a pull request so it can be tracked. ### Merge approval @@ -73,7 +73,7 @@ git commit -s ## Communication -Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling-serve/discussions). +Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling-serve/discussions). ## Developing diff --git a/Makefile b/Makefile index 1dc4718..a5f10fe 100644 --- a/Makefile +++ b/Makefile @@ -27,23 +27,23 @@ md-lint-file: .PHONY: docling-serve-image docling-serve-image: Containerfile $(ECHO_PREFIX) printf " %-12s Containerfile\n" "[docling-serve]" - $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cu124 --no-extra cpu" -f Containerfile -t ghcr.io/ds4sd/docling-serve:$(TAG) . - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve:$(TAG) ghcr.io/ds4sd/docling-serve:main - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve:$(TAG) quay.io/ds4sd/docling-serve:main + $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cu124 --no-extra cpu" -f Containerfile -t ghcr.io/docling-project/docling-serve:$(TAG) . + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve:$(TAG) ghcr.io/docling-project/docling-serve:main + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve:$(TAG) quay.io/docling-project/docling-serve:main .PHONY: docling-serve-cpu-image docling-serve-cpu-image: Containerfile ## Build docling-serve "cpu only" container image $(ECHO_PREFIX) printf " %-12s Containerfile\n" "[docling-serve CPU]" - $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cu124" -f Containerfile -t ghcr.io/ds4sd/docling-serve-cpu:$(TAG) . - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cpu:$(TAG) ghcr.io/ds4sd/docling-serve-cpu:main - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cpu:$(TAG) quay.io/ds4sd/docling-serve-cpu:main + $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cu124" -f Containerfile -t ghcr.io/docling-project/docling-serve-cpu:$(TAG) . + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve-cpu:$(TAG) ghcr.io/docling-project/docling-serve-cpu:main + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve-cpu:$(TAG) quay.io/docling-project/docling-serve-cpu:main .PHONY: docling-serve-cu124-image docling-serve-cu124-image: Containerfile ## Build docling-serve container image with GPU support $(ECHO_PREFIX) printf " %-12s Containerfile\n" "[docling-serve with Cuda 12.4]" - $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cpu" -f Containerfile --platform linux/amd64 -t ghcr.io/ds4sd/docling-serve-cu124:$(TAG) . - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cu124:$(TAG) ghcr.io/ds4sd/docling-serve-cu124:main - $(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cu124:$(TAG) quay.io/ds4sd/docling-serve-cu124:main + $(CMD_PREFIX) docker build --load --build-arg "UV_SYNC_EXTRA_ARGS=--no-extra cpu" -f Containerfile --platform linux/amd64 -t ghcr.io/docling-project/docling-serve-cu124:$(TAG) . + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve-cu124:$(TAG) ghcr.io/docling-project/docling-serve-cu124:main + $(CMD_PREFIX) docker tag ghcr.io/docling-project/docling-serve-cu124:$(TAG) quay.io/docling-project/docling-serve-cu124:main .PHONY: action-lint action-lint: .action-lint ## Lint GitHub Action workflows @@ -84,11 +84,11 @@ run-docling-cpu: ## Run the docling-serve container with CPU support and assign $(ECHO_PREFIX) printf " %-12s Removing existing container if it exists...\n" "[CLEANUP]" $(CMD_PREFIX) docker rm -f docling-serve-cpu 2>/dev/null || true $(ECHO_PREFIX) printf " %-12s Running docling-serve container with CPU support on port 5001...\n" "[RUN CPU]" - $(CMD_PREFIX) docker run -it --name docling-serve-cpu -p 5001:5001 ghcr.io/ds4sd/docling-serve-cpu:main + $(CMD_PREFIX) docker run -it --name docling-serve-cpu -p 5001:5001 ghcr.io/docling-project/docling-serve-cpu:main .PHONY: run-docling-gpu run-docling-gpu: ## Run the docling-serve container with GPU support and assign a container name $(ECHO_PREFIX) printf " %-12s Removing existing container if it exists...\n" "[CLEANUP]" $(CMD_PREFIX) docker rm -f docling-serve-gpu 2>/dev/null || true $(ECHO_PREFIX) printf " %-12s Running docling-serve container with GPU support on port 5001...\n" "[RUN GPU]" - $(CMD_PREFIX) docker run -it --name docling-serve-gpu -p 5001:5001 ghcr.io/ds4sd/docling-serve:main + $(CMD_PREFIX) docker run -it --name docling-serve-gpu -p 5001:5001 ghcr.io/docling-project/docling-serve:main diff --git a/README.md b/README.md index c6b797b..b4e9dae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Docling Serve - Running [Docling](https://github.com/DS4SD/docling) as an API service. + Running [Docling](https://github.com/docling-project/docling) as an API service. ## Usage @@ -421,11 +421,11 @@ Others: ## Get help and support -Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions). +Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling/discussions). ## Contributing -Please read [Contributing to Docling Serve](https://github.com/DS4SD/docling-serve/blob/main/CONTRIBUTING.md) for details. +Please read [Contributing to Docling Serve](https://github.com/docling-project/docling-serve/blob/main/CONTRIBUTING.md) for details. ## References diff --git a/docling_serve/app.py b/docling_serve/app.py index 0bb6510..9fb535e 100644 --- a/docling_serve/app.py +++ b/docling_serve/app.py @@ -178,7 +178,7 @@ def create_app(): # noqa: C901 @app.get("/favicon.ico", include_in_schema=False) async def favicon(): response = RedirectResponse( - url="https://ds4sd.github.io/docling/assets/logo.png" + url="https://raw.githubusercontent.com/docling-project/docling/refs/heads/main/docs/assets/logo.svg" ) return response diff --git a/docling_serve/gradio_ui.py b/docling_serve/gradio_ui.py index 4b6f1ec..2c55829 100644 --- a/docling_serve/gradio_ui.py +++ b/docling_serve/gradio_ui.py @@ -359,7 +359,7 @@ with gr.Blocks( # Logo with gr.Column(scale=1, min_width=90): gr.Image( - "https://ds4sd.github.io/docling/assets/logo.png", + "https://raw.githubusercontent.com/docling-project/docling/refs/heads/main/docs/assets/logo.svg", height=80, width=80, show_download_button=False, diff --git a/pyproject.toml b/pyproject.toml index b3477d5..68435bd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -109,11 +109,11 @@ namespaces = true docling-serve = "docling_serve.__main__:main" [project.urls] -Homepage = "https://github.com/DS4SD/docling-serve" +Homepage = "https://github.com/docling-project/docling-serve" # Documentation = "https://ds4sd.github.io/docling" -Repository = "https://github.com/DS4SD/docling-serve" -Issues = "https://github.com/DS4SD/docling-serve/issues" -Changelog = "https://github.com/DS4SD/docling-serve/blob/main/CHANGELOG.md" +Repository = "https://github.com/docling-project/docling-serve" +Issues = "https://github.com/docling-project/docling-serve/issues" +Changelog = "https://github.com/docling-project/docling-serve/blob/main/CHANGELOG.md" [tool.ruff] target-version = "py310"