mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-05 04:13:25 +00:00
Alex
bea26336f8
pip install docsgpt (extras: docling, milvus) installs the backend with a docsgpt command: api, worker, migrate, prefetch-models, verify-offline, reembed. Second step of the PyPI work after the package rename. - hatchling build; the version comes from docsgpt/version.py. The wheel is the docsgpt package with the data it reads at runtime (prompts, model catalogs, seed config, alembic.ini and migrations) and without the Dockerfile, the exported requirements, the sample index and local runtime data. The application import alias stays checkout-only. uv sync installs the package editable now that [tool.uv] package = false is gone. - docsgpt/cli.py: api (gunicorn + BoundedDrainUvicornWorker with the image's flags, --reload for uvicorn), worker (Celery worker with beat embedded, --no-beat/-Q/--concurrency/--pool, solo pool on macOS), migrate, and argument pass-through to the maintenance scripts. --help imports no app. - docsgpt/core/paths.py: runtime data lives in a data home (DOCSGPT_HOME, else the checkout, else cwd); DOCSGPT_ENV_FILE overrides the env file. Settings, the dotenv load, LocalStorage and the internal upload route use it instead of "three directories above this file", which is site-packages for an installed package. A checkout and the Docker image behave as before. - [project] dependencies are compatible ranges so the package installs next to other packages; uv.lock resolves to the same versions and the exported requirements files are unchanged. - package-build.yml builds and checks the wheel on PRs and installs it into a clean venv; pypi-publish.yml publishes on a published release through trusted publishing (environment pypi), or to TestPyPI on a manual run. - Docs: Deploying -> Install with pip. AGENTS.md notes the package.
89 lines
2.9 KiB
YAML
89 lines
2.9 KiB
YAML
name: Build the Python package
|
|
|
|
# Builds the sdist and wheel, checks the wheel carries the data the app reads
|
|
# at runtime and nothing from the checkout, then installs it into a clean
|
|
# environment and runs the docsgpt command.
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- 'pyproject.toml'
|
|
- 'uv.lock'
|
|
- 'docsgpt/**'
|
|
- 'README.md'
|
|
- 'LICENSE'
|
|
- '.github/workflows/package-build.yml'
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'pyproject.toml'
|
|
- 'uv.lock'
|
|
- 'docsgpt/**'
|
|
- 'README.md'
|
|
- 'LICENSE'
|
|
- '.github/workflows/package-build.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
|
|
|
|
- name: Build the sdist and wheel
|
|
run: uv build
|
|
|
|
- name: Check the archives
|
|
run: |
|
|
uvx twine check --strict dist/*
|
|
python3 - <<'PY'
|
|
import glob
|
|
import zipfile
|
|
|
|
names = set(zipfile.ZipFile(glob.glob("dist/*.whl")[0]).namelist())
|
|
for required in (
|
|
"docsgpt/cli.py",
|
|
"docsgpt/alembic.ini",
|
|
"docsgpt/alembic/env.py",
|
|
"docsgpt/alembic/script.py.mako",
|
|
"docsgpt/prompts/chat_reduce_prompt.txt",
|
|
"docsgpt/prompts/fragments/identity.txt",
|
|
"docsgpt/core/models/_defaults.yaml",
|
|
"docsgpt/seed/config/premade_agents.yaml",
|
|
):
|
|
assert required in names, f"missing from the wheel: {required}"
|
|
for banned in (
|
|
"docsgpt/Dockerfile",
|
|
"docsgpt/requirements.txt",
|
|
"docsgpt/requirements-docling.txt",
|
|
"docsgpt/index.faiss",
|
|
"docsgpt/index.pkl",
|
|
"application/__init__.py",
|
|
):
|
|
assert banned not in names, f"must not ship: {banned}"
|
|
stray = [n for n in names if n.startswith(("docsgpt/indexes/", "docsgpt/inputs/", "docsgpt/vectors/"))]
|
|
assert not stray, stray
|
|
print(f"wheel ok: {len(names)} files")
|
|
PY
|
|
|
|
- name: Install the wheel into a clean environment and run the command
|
|
run: |
|
|
uv venv "$RUNNER_TEMP/docsgpt-venv"
|
|
uv pip install --python "$RUNNER_TEMP/docsgpt-venv/bin/python" dist/*.whl
|
|
"$RUNNER_TEMP/docsgpt-venv/bin/docsgpt" --version
|
|
"$RUNNER_TEMP/docsgpt-venv/bin/docsgpt" --help
|
|
"$RUNNER_TEMP/docsgpt-venv/bin/docsgpt" api --help
|
|
"$RUNNER_TEMP/docsgpt-venv/bin/python" -c "from docsgpt.core import paths; print('home:', paths.home_dir())"
|
|
|
|
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
|
with:
|
|
name: dist
|
|
path: dist/
|