docforge-cli 0.2.0__tar.gz → 0.2.1__tar.gz

{docforge_cli-0.2.0 → docforge_cli-0.2.1}/PKG-INFO

@@ -1,8 +1,13 @@
 Metadata-Version: 2.4
 Name: docforge-cli
-Version: 0.2.0
+Version: 0.2.1
 Summary: Forge searchable context from Confluence and git repos for AI coding assistants
 License: MIT
+Project-URL: Homepage, https://GranatenUdo.github.io/docforge/
+Project-URL: Source, https://github.com/GranatenUdo/docforge
+Project-URL: Issues, https://github.com/GranatenUdo/docforge/issues
+Project-URL: Changelog, https://github.com/GranatenUdo/docforge/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://GranatenUdo.github.io/docforge/
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -140,29 +145,26 @@ Contributions welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development
 
 ## Evaluation & retrieval quality
 
-docforge ships with a retrieval-quality eval harness at [`docforge/scripts/eval_search.py`](docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`docforge/scripts/README.md`](docforge/scripts/README.md) for details.
+docforge ships with a retrieval-quality eval harness at [`src/docforge/scripts/eval_search.py`](src/docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`src/docforge/scripts/README.md`](src/docforge/scripts/README.md) for details.
 
 ## FAQ
 
-### "Cannot connect to PostgreSQL"
-
-Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
+The three install-time issues new users hit most often are inline below. The
+full FAQ — including "no results found", "ingest skipped everything", removing
+sources, swapping embedding models, and where to file issues — lives on the
+[microsite FAQ](https://GranatenUdo.github.io/docforge/faq/).
 
 ### "HF_TOKEN required" or model download fails
 
 The embedding model `google/embeddinggemma-300m` requires a Hugging Face token with access to the gated model. Create one at https://huggingface.co/settings/tokens, accept the model license at https://huggingface.co/google/embeddinggemma-300m, and set `HF_TOKEN=hf_...` in `.env`.
 
-### "No results found" after ingest
-
-Run `docforge status` to confirm sources and chunks exist. If counts are zero, check the ingest logs for per-source failures — the summary at the end lists sources that failed.
-
 ### First ingest / first container start is very slow
 
 The first run downloads the 300M embedding model (~1.2 GB) from Hugging Face. Locally, the model is cached at `~/.cache/huggingface/`. In the Docker image, it is cached at `/app/.cache/huggingface/` — **mount this as a volume** so container restarts do not re-download: `docker run -v docforge-hf-cache:/app/.cache/huggingface ...`.
 
-### "Ingest skipped everything"
+### "Cannot connect to PostgreSQL"
 
-docforge skips sources whose `content_hash` matches the stored hash (no changes detected). To force re-ingest, clear the hash: `UPDATE sources SET content_hash = NULL;` then run `docforge ingest`.
+Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
 
 ## License
 

{docforge_cli-0.2.0 → docforge_cli-0.2.1}/README.md

@@ -107,29 +107,26 @@ Contributions welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development
 
 ## Evaluation & retrieval quality
 
-docforge ships with a retrieval-quality eval harness at [`docforge/scripts/eval_search.py`](docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`docforge/scripts/README.md`](docforge/scripts/README.md) for details.
+docforge ships with a retrieval-quality eval harness at [`src/docforge/scripts/eval_search.py`](src/docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`src/docforge/scripts/README.md`](src/docforge/scripts/README.md) for details.
 
 ## FAQ
 
-### "Cannot connect to PostgreSQL"
-
-Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
+The three install-time issues new users hit most often are inline below. The
+full FAQ — including "no results found", "ingest skipped everything", removing
+sources, swapping embedding models, and where to file issues — lives on the
+[microsite FAQ](https://GranatenUdo.github.io/docforge/faq/).
 
 ### "HF_TOKEN required" or model download fails
 
 The embedding model `google/embeddinggemma-300m` requires a Hugging Face token with access to the gated model. Create one at https://huggingface.co/settings/tokens, accept the model license at https://huggingface.co/google/embeddinggemma-300m, and set `HF_TOKEN=hf_...` in `.env`.
 
-### "No results found" after ingest
-
-Run `docforge status` to confirm sources and chunks exist. If counts are zero, check the ingest logs for per-source failures — the summary at the end lists sources that failed.
-
 ### First ingest / first container start is very slow
 
 The first run downloads the 300M embedding model (~1.2 GB) from Hugging Face. Locally, the model is cached at `~/.cache/huggingface/`. In the Docker image, it is cached at `/app/.cache/huggingface/` — **mount this as a volume** so container restarts do not re-download: `docker run -v docforge-hf-cache:/app/.cache/huggingface ...`.
 
-### "Ingest skipped everything"
+### "Cannot connect to PostgreSQL"
 
-docforge skips sources whose `content_hash` matches the stored hash (no changes detected). To force re-ingest, clear the hash: `UPDATE sources SET content_hash = NULL;` then run `docforge ingest`.
+Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
 
 ## License
 

{docforge_cli-0.2.0 → docforge_cli-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "docforge-cli"
-version = "0.2.0"
+version = "0.2.1"
 description = "Forge searchable context from Confluence and git repos for AI coding assistants"
 readme = "README.md"
 license = {text = "MIT"}
@@ -25,6 +25,13 @@ dependencies = [
     "numpy>=1.26",
 ]
 
+[project.urls]
+Homepage = "https://GranatenUdo.github.io/docforge/"
+Source = "https://github.com/GranatenUdo/docforge"
+Issues = "https://github.com/GranatenUdo/docforge/issues"
+Changelog = "https://github.com/GranatenUdo/docforge/blob/master/CHANGELOG.md"
+Documentation = "https://GranatenUdo.github.io/docforge/"
+
 [project.scripts]
 docforge = "docforge.cli:app"
 
@@ -44,6 +51,7 @@ entra = [
 ]
 
 [tool.setuptools.packages.find]
+where = ["src"]
 include = ["docforge*"]
 
 [tool.setuptools.package-data]
@@ -62,7 +70,7 @@ testpaths = ["tests"]
 markers = [
     "integration: requires Docker (pgvector container)",
 ]
-addopts = "--cov=docforge"
+addopts = "--cov=src/docforge"
 
 [tool.coverage.report]
 fail_under = 60

{docforge_cli-0.2.0 → docforge_cli-0.2.1/src}/docforge_cli.egg-info/PKG-INFO

@@ -1,8 +1,13 @@
 Metadata-Version: 2.4
 Name: docforge-cli
-Version: 0.2.0
+Version: 0.2.1
 Summary: Forge searchable context from Confluence and git repos for AI coding assistants
 License: MIT
+Project-URL: Homepage, https://GranatenUdo.github.io/docforge/
+Project-URL: Source, https://github.com/GranatenUdo/docforge
+Project-URL: Issues, https://github.com/GranatenUdo/docforge/issues
+Project-URL: Changelog, https://github.com/GranatenUdo/docforge/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://GranatenUdo.github.io/docforge/
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -140,29 +145,26 @@ Contributions welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development
 
 ## Evaluation & retrieval quality
 
-docforge ships with a retrieval-quality eval harness at [`docforge/scripts/eval_search.py`](docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`docforge/scripts/README.md`](docforge/scripts/README.md) for details.
+docforge ships with a retrieval-quality eval harness at [`src/docforge/scripts/eval_search.py`](src/docforge/scripts/eval_search.py). It measures recall@1, recall@k, and MRR against a ground-truth query set you maintain. The harness is designed for **drift detection** — run it after `sources.yml` changes, embedding-model updates, or ranking tweaks, and compare against your baseline. There is no absolute quality threshold; the metric magnitude depends on how closely your ground-truth queries match source titles. See [`src/docforge/scripts/README.md`](src/docforge/scripts/README.md) for details.
 
 ## FAQ
 
-### "Cannot connect to PostgreSQL"
-
-Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
+The three install-time issues new users hit most often are inline below. The
+full FAQ — including "no results found", "ingest skipped everything", removing
+sources, swapping embedding models, and where to file issues — lives on the
+[microsite FAQ](https://GranatenUdo.github.io/docforge/faq/).
 
 ### "HF_TOKEN required" or model download fails
 
 The embedding model `google/embeddinggemma-300m` requires a Hugging Face token with access to the gated model. Create one at https://huggingface.co/settings/tokens, accept the model license at https://huggingface.co/google/embeddinggemma-300m, and set `HF_TOKEN=hf_...` in `.env`.
 
-### "No results found" after ingest
-
-Run `docforge status` to confirm sources and chunks exist. If counts are zero, check the ingest logs for per-source failures — the summary at the end lists sources that failed.
-
 ### First ingest / first container start is very slow
 
 The first run downloads the 300M embedding model (~1.2 GB) from Hugging Face. Locally, the model is cached at `~/.cache/huggingface/`. In the Docker image, it is cached at `/app/.cache/huggingface/` — **mount this as a volume** so container restarts do not re-download: `docker run -v docforge-hf-cache:/app/.cache/huggingface ...`.
 
-### "Ingest skipped everything"
+### "Cannot connect to PostgreSQL"
 
-docforge skips sources whose `content_hash` matches the stored hash (no changes detected). To force re-ingest, clear the hash: `UPDATE sources SET content_hash = NULL;` then run `docforge ingest`.
+Check that the database is running: `docker compose up -d db`. Verify `DATABASE_URL` in `.env` points to `postgresql://docforge:localdev@localhost:5432/docforge` (or your custom value).
 
 ## License
 

docforge_cli-0.2.1/src/docforge_cli.egg-info/SOURCES.txt

@@ -0,0 +1,42 @@
+LICENSE
+README.md
+pyproject.toml
+src/docforge/__init__.py
+src/docforge/__main__.py
+src/docforge/api.py
+src/docforge/cli.py
+src/docforge/config.py
+src/docforge/db.py
+src/docforge/ingest.py
+src/docforge/lint.py
+src/docforge/mcp_server.py
+src/docforge/query_log.py
+src/docforge/ranking.py
+src/docforge/sources.py
+src/docforge/crawlers/__init__.py
+src/docforge/crawlers/confluence.py
+src/docforge/crawlers/git.py
+src/docforge/processors/__init__.py
+src/docforge/processors/chunker.py
+src/docforge/processors/embedder.py
+src/docforge/processors/parser.py
+src/docforge/scripts/__init__.py
+src/docforge/scripts/eval_search.py
+src/docforge/scripts/latency_report.py
+src/docforge/sql/schema.sql
+src/docforge/sql/migrations/001_add_source_identifier.sql
+src/docforge/sql/migrations/002_add_status_index.sql
+src/docforge/sql/migrations/003_add_source_tags.sql
+src/docforge/sql/migrations/004_add_query_log.sql
+src/docforge/sql/migrations/005_add_query_log_user_oid.sql
+src/docforge/sql/migrations/006_add_query_log_request_ms.sql
+src/docforge/templates/docforge.yml
+src/docforge/templates/docker-compose.yml
+src/docforge/templates/mcp_client.py
+src/docforge/templates/sources.yml
+src/docforge_cli.egg-info/PKG-INFO
+src/docforge_cli.egg-info/SOURCES.txt
+src/docforge_cli.egg-info/dependency_links.txt
+src/docforge_cli.egg-info/entry_points.txt
+src/docforge_cli.egg-info/requires.txt
+src/docforge_cli.egg-info/top_level.txt

docforge_cli-0.2.0/docforge_cli.egg-info/SOURCES.txt

@@ -1,42 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-docforge/__init__.py
-docforge/__main__.py
-docforge/api.py
-docforge/cli.py
-docforge/config.py
-docforge/db.py
-docforge/ingest.py
-docforge/lint.py
-docforge/mcp_server.py
-docforge/query_log.py
-docforge/ranking.py
-docforge/sources.py
-docforge/crawlers/__init__.py
-docforge/crawlers/confluence.py
-docforge/crawlers/git.py
-docforge/processors/__init__.py
-docforge/processors/chunker.py
-docforge/processors/embedder.py
-docforge/processors/parser.py
-docforge/scripts/__init__.py
-docforge/scripts/eval_search.py
-docforge/scripts/latency_report.py
-docforge/sql/schema.sql
-docforge/sql/migrations/001_add_source_identifier.sql
-docforge/sql/migrations/002_add_status_index.sql
-docforge/sql/migrations/003_add_source_tags.sql
-docforge/sql/migrations/004_add_query_log.sql
-docforge/sql/migrations/005_add_query_log_user_oid.sql
-docforge/sql/migrations/006_add_query_log_request_ms.sql
-docforge/templates/docforge.yml
-docforge/templates/docker-compose.yml
-docforge/templates/mcp_client.py
-docforge/templates/sources.yml
-docforge_cli.egg-info/PKG-INFO
-docforge_cli.egg-info/SOURCES.txt
-docforge_cli.egg-info/dependency_links.txt
-docforge_cli.egg-info/entry_points.txt
-docforge_cli.egg-info/requires.txt
-docforge_cli.egg-info/top_level.txt