mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2026-09-03 05:10:16 +03:00
05eb74022a
# Description of Changes This PR modernizes the project's Python tooling across GitHub Actions by migrating CI workflows from pip-based dependency management to `uv` and aligning Python execution with the engine project's managed environment. ### What was changed - Replaced `actions/setup-python` and ad-hoc `pip install` steps with `astral-sh/setup-uv` across CI workflows. - Configured shared `uv` dependency caching using `engine/pyproject.toml` and `engine/uv.lock`. - Updated Python script execution to use `uv run --project engine --locked` for a consistent runtime environment. - Replaced package installation steps with `uv sync` for the required dependency groups (e.g. `tools` and `cucumber`). - Added Docker image build validation for both production and development AI engine images. - Updated workflow cache configuration and Docker build context where required. - Removed obsolete Python requirements files that are no longer needed after the migration. - Applied minor Python code modernizations, including import cleanup, modern built-in generic type annotations (`list[...]`, `tuple[...]`, `float | None`), and small style improvements. - Removed unnecessary Python formatter/linter extensions from the development container configuration. ### Why the change was made - Standardize Python dependency management across the repository. - Reduce duplicated dependency installation logic in CI. - Improve workflow performance through shared dependency caching. - Ensure all Python utilities execute against the same locked dependency set managed by the engine project. - Simplify long-term maintenance by eliminating legacy requirements files and pip-specific workflow steps. --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have run `task check` to verify linters, typechecks, and tests pass - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details. --------- Signed-off-by: Carsten Drewes <c.drewes@stud.uni-hannover.de> Co-authored-by: albanobattistella <34811668+albanobattistella@users.noreply.github.com> Co-authored-by: kastenherri <116314318+kastenherri@users.noreply.github.com> Co-authored-by: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: James Brunton <jbrunton96@gmail.com>
121 lines
3.1 KiB
TOML
121 lines
3.1 KiB
TOML
[project]
|
|
name = "engine"
|
|
version = "0.1.0"
|
|
description = "Stirling PDF Python projects"
|
|
requires-python = ">=3.13,<3.14"
|
|
dependencies = []
|
|
|
|
[dependency-groups]
|
|
# Runtime dependencies for the AI document engine service.
|
|
engine = [
|
|
"cryptography>=50.0.0",
|
|
"fastapi>=0.141.1",
|
|
"opentelemetry-sdk>=1.39.1",
|
|
"pgvector>=0.5.0",
|
|
"posthog>=7.38.3",
|
|
"psycopg[binary,pool]>=3.3.4",
|
|
"pydantic>=2.13.4",
|
|
# <2 cap: 1.99.0 patches CVE-2026-46678; 2.0 is an untested major migration.
|
|
"pydantic-ai>=1.107.2,<2.0.0",
|
|
"pydantic-ai-slim[voyageai]>=1.107.2,<2.0.0",
|
|
"pydantic-settings>=2.15.0",
|
|
"python-dotenv>=1.2.2",
|
|
"sqlite-vec>=0.1.9",
|
|
"uvicorn>=0.52.1",
|
|
]
|
|
# Type checking, testing, model generation, and formatting tools for the engine.
|
|
engine-dev = [
|
|
"anyio>=4.14.2",
|
|
"datamodel-code-generator[ruff]==0.64.0",
|
|
"pyright>=1.1.411",
|
|
"pytest>=9.1.1",
|
|
"referencing>=0.37.0",
|
|
"ruff==0.15.5",
|
|
]
|
|
# Dependencies for the Cucumber/Python integration test suite.
|
|
cucumber = [
|
|
"behave>=1.3.3",
|
|
"behave-html-formatter>=0.9.10",
|
|
"opencv-python-headless>=5.0.0.93",
|
|
"pdf2image>=1.17.0",
|
|
"pillow>=12.3.0",
|
|
"pypdf[crypto]>=6.15.0",
|
|
"qrcode[pil]>=8.2",
|
|
"reportlab>=5.0.0",
|
|
"requests>=2.34.2",
|
|
]
|
|
# Shared Python utilities used by repository scripts and CI workflows.
|
|
tools = [
|
|
"deep-translator>=1.11.4",
|
|
"defusedxml>=0.7.1",
|
|
"fonttools>=4.63.0",
|
|
"fpdf2>=2.8.7",
|
|
"openai>=2.53.0",
|
|
"requests>=2.34.2",
|
|
"tomli-w>=1.2.0",
|
|
"tomlkit>=0.15.1",
|
|
"urllib3>=2.7.0",
|
|
"unoserver>=3.7",
|
|
"weasyprint>=69.0",
|
|
]
|
|
# Release-signature verification dependencies.
|
|
updater-signatures = [
|
|
"cryptography>=50.0.0",
|
|
]
|
|
# Pinned repository-wide pre-commit tooling.
|
|
pre-commit = [
|
|
"codespell==2.4.2",
|
|
"ruff==0.15.5",
|
|
"tomli-w==1.2.0",
|
|
]
|
|
|
|
[build-system]
|
|
requires = ["hatchling"]
|
|
build-backend = "hatchling.build"
|
|
|
|
[tool.hatch.build.targets.wheel]
|
|
packages = ["src"]
|
|
exclude = ["tests"]
|
|
|
|
[tool.uv]
|
|
default-groups = []
|
|
|
|
[tool.ruff]
|
|
line-length = 120
|
|
target-version = "py313"
|
|
|
|
[tool.ruff.lint]
|
|
select = [
|
|
"E",
|
|
"F",
|
|
"I",
|
|
"N",
|
|
"W",
|
|
"RUF100",
|
|
"UP",
|
|
"PYI", # flake8-pyi: flags deprecated typing constructs
|
|
"FA", # flake8-future-annotations: flags missing future annotations imports
|
|
"BLE", # flake8-blind-except: flags bare `except Exception`
|
|
]
|
|
|
|
[tool.ruff.lint.isort]
|
|
known-first-party = ["stirling", "tests"]
|
|
|
|
[tool.pyright]
|
|
pythonVersion = "3.13"
|
|
reportImportCycles = "warning"
|
|
reportUnnecessaryCast = "warning"
|
|
reportUnnecessaryTypeIgnoreComment = "warning"
|
|
reportUnusedImport = "warning"
|
|
reportUnknownParameterType = "warning"
|
|
reportDeprecated = "warning"
|
|
|
|
[tool.pytest.ini_options]
|
|
testpaths = ["tests"]
|
|
# ``tests`` is on the path so test modules can import shared helpers (e.g.
|
|
# ``from conftest import build_app_settings``) without packaging the tests dir.
|
|
pythonpath = ["src", "tests"]
|
|
# Use importlib import mode so test directories don't need __init__.py files
|
|
# and duplicate basenames (e.g. multiple test_routes.py) collect cleanly.
|
|
addopts = "--import-mode=importlib"
|