biblicus 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

biblicus-0.1.1.dist-info/METADATA

@@ -1,174 +0,0 @@
-Metadata-Version: 2.4
-Name: biblicus
-Version: 0.1.1
-Summary: Command line interface and Python library for corpus ingestion, retrieval, and evaluation.
-License: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydantic>=2.0
-Requires-Dist: PyYAML>=6.0
-Provides-Extra: dev
-Requires-Dist: behave>=1.2.6; extra == "dev"
-Requires-Dist: coverage[toml]>=7.0; extra == "dev"
-Requires-Dist: sphinx>=7.0; extra == "dev"
-Requires-Dist: myst-parser>=2.0; extra == "dev"
-Requires-Dist: ruff>=0.4.0; extra == "dev"
-Requires-Dist: black>=24.0; extra == "dev"
-Requires-Dist: python-semantic-release>=9.0.0; extra == "dev"
-Dynamic: license-file
-
-# Biblicus
-
-Make your documents usable by your assistant, then decide later how you will search and retrieve them.
-
-If you are building an assistant in Python, you probably have material you want it to use: notes, documents, web pages, and reference files. A common approach is retrieval augmented generation, where a system retrieves relevant material and uses it as evidence when generating a response.
-
-The first practical problem is not retrieval. It is collection and care. You need a stable place to put raw items, you need a small amount of metadata so you can find them again, and you need a way to evolve your retrieval approach over time without rewriting ingestion.
-
-This library gives you a corpus, which is a normal folder on disk. It stores each ingested item as a file, with optional metadata stored next to it. You can open and inspect the raw files directly. Any derived catalog or index can be rebuilt from the raw corpus.
-
-It integrates with LangChain, Tactus, Pydantic AI, and the agent development kit. Use it from Python or from the command line interface.
-
-See [retrieval augmented generation overview] for a short introduction to the idea.
-
-## The framework
-
-The framework is a small, explicit vocabulary that appears in code, specifications, and documentation. If you learn these words, the rest of the system becomes predictable.
-
-- Corpus is the folder that holds raw items and their metadata.
-- Item is the raw bytes of a document or other artifact, plus its source.
-- Catalog is the rebuildable index of the corpus.
-- Evidence is what retrieval returns, ready to be turned into context for a large language model.
-- Run is a recorded retrieval build for a corpus.
-- Backend is a pluggable retrieval implementation.
-- Recipe is a named configuration for a backend.
-- Pipeline stage is a distinct retrieval step such as retrieve, rerank, and filter.
-
-## Practical value
-
-- You can ingest raw material once, then try many retrieval approaches over time.
-- You can keep raw files readable and portable, without locking your data inside a database.
-- You can evaluate retrieval runs against shared datasets and compare backends using the same corpus.
-
-## Typical flow
-
-- Initialize a corpus folder.
-- Ingest items from file paths, web addresses, or text input.
-- Reindex to refresh the catalog after edits.
-- Build a retrieval run with a backend.
-- Query the run to collect evidence and evaluate it with datasets.
-
-## Install
-
-This repository is a working Python package. Install it into a virtual environment from the repository root.
-
-```
-python3 -m pip install -e .
-```
-
-After the first release, you can install it from Python Package Index.
-
-```
-python3 -m pip install biblicus
-```
-
-## Quick start
-
-```
-biblicus init corpora/example
-biblicus ingest --corpus corpora/example notes/example.txt
-echo "A short note" | biblicus ingest --corpus corpora/example --stdin --title "First note"
-biblicus list --corpus corpora/example
-biblicus build --corpus corpora/example --backend scan
-biblicus query --corpus corpora/example --query "note"
-```
-
-## Python usage
-
-From Python, the same flow is available through the Corpus class and backend interfaces. The public surface area is small on purpose.
-
-- Create a corpus with `Corpus.init` or open one with `Corpus.open`.
-- Ingest notes with `Corpus.ingest_note`.
-- Ingest files or web addresses with `Corpus.ingest_source`.
-- List items with `Corpus.list_items`.
-- Build a retrieval run with `get_backend` and `backend.build_run`.
-- Query a run with `backend.query`.
-- Evaluate with `evaluate_run`.
-
-## How it fits into an assistant
-
-In an assistant system, retrieval usually produces context for a model call. This library treats evidence as the primary output so you can decide how to use it.
-
-- Use a corpus as the source of truth for raw items.
-- Use a backend run to build any derived artifacts needed for retrieval.
-- Use queries to obtain evidence objects.
-- Convert evidence into the format your framework expects, such as message content, tool output, or citations.
-
-## Learn more
-
-The documents below are written to be read in order.
-
-- [Architecture][architecture]
-- [Backends][backends]
-
-## Metadata and catalog
-
-Raw items are stored as files in the corpus raw directory. Metadata can live in a Markdown front matter block or a sidecar file with the suffix `.biblicus.yml`. The catalog lives in `.biblicus/catalog.json` and can be rebuilt at any time with `biblicus reindex`.
-
-## Corpus layout
-
-```
-corpus/
-  raw/
-    item.bin
-    item.bin.biblicus.yml
-  .biblicus/
-    config.json
-    catalog.json
-    runs/
-      run-id.json
-```
-
-## Retrieval backends
-
-Two backends are included.
-
-- `scan` is a minimal baseline that scans raw items directly.
-- `sqlite-full-text-search` is a practical baseline that builds a full text search index in Sqlite.
-
-## Integration corpus and evaluation dataset
-
-Use `scripts/download_wikipedia.py` to download a small integration corpus from Wikipedia when running tests or demos. The repository does not include that content.
-
-The dataset file `datasets/wikipedia_mini.json` provides a small evaluation set that matches the integration corpus.
-
-## Tests and coverage
-
-```
-python3 scripts/test.py
-```
-
-## Releases
-
-Releases are automated from the main branch using semantic versioning and conventional commit messages.
-
-The release pipeline publishes a GitHub release and uploads the package to Python Package Index when continuous integration succeeds.
-
-Publishing uses a Python Package Index token stored in the GitHub secret named PYPI_TOKEN.
-
-## Documentation
-
-Reference documentation is generated from Sphinx style docstrings. Build the documentation with the command below.
-
-```
-sphinx-build -b html docs docs/_build
-```
-
-## License
-
-License terms are in `LICENSE`.
-
-[retrieval augmented generation overview]: https://en.wikipedia.org/wiki/Retrieval-augmented_generation
-[architecture]: docs/ARCHITECTURE.md
-[backends]: docs/BACKENDS.md

biblicus-0.1.1.dist-info/RECORD

@@ -1,22 +0,0 @@
-biblicus/__init__.py,sha256=o_1kQ7q9DCcjH7zm5MAvPx49hArnSvbr88kHKzBFMvM,432
-biblicus/__main__.py,sha256=ipfkUoTlocVnrQDM69C7TeBqQxmHVeiWMRaT3G9rtnk,117
-biblicus/cli.py,sha256=DwnvcDmjelzUq_9VMo_U_-FoBs3Si3QONVJdWGonXs4,15116
-biblicus/constants.py,sha256=t8p0yStpJAYPxsFlM0u5zJcQr_ARKEqEnIgNckjyF5Y,196
-biblicus/corpus.py,sha256=953gzT77HvYeTs2pcBXyixYRTxh65nm1JtlHVfKvCzg,30921
-biblicus/evaluation.py,sha256=H_W35vF5_L4B2JCfLu19VRu402tZ2pFkN2BbBP69lVY,8119
-biblicus/frontmatter.py,sha256=8Tqlpd3bVzZrGRB9Rdj2IwHMSJLvd2ABxMNOi3L5br4,2466
-biblicus/models.py,sha256=ZDb7-t9pycPpgZWVs5CcrpyeA_8OZLoQk-aflKjU7M4,10512
-biblicus/retrieval.py,sha256=T7HELWCNAxZ26yj7dPH8IBUaxV_gx8Ql9iwwGz0teyI,4184
-biblicus/sources.py,sha256=XFF75kqMyYdeYy6k8NtDnOmCxAmroW7DH6mdzWMPMuY,4358
-biblicus/time.py,sha256=rvp2fJXSLVmyA76GCfNKtZoifASodemJTOWN8smPt0s,486
-biblicus/uris.py,sha256=sRDyGmoHr_H4XR4qv_lSbQJXylYD0fNEr02H5wjomnQ,1986
-biblicus/backends/__init__.py,sha256=5OXKSzsn7THhwh9T5StOvEqojx_85XXuYSGdTpMK11U,1214
-biblicus/backends/base.py,sha256=699TKygGgL72Ifkhz1V890nOK6BslwO0-OY7xeqZl-I,1764
-biblicus/backends/scan.py,sha256=qvktqHIB0459sjzEO4EnS1PCXwwM19LjOx8oaDoU7DQ,9245
-biblicus/backends/sqlite_full_text_search.py,sha256=s_3gsEcdlxSFuluWcug4XEklwEoY42_Dgd7luY-BqqI,14152
-biblicus-0.1.1.dist-info/licenses/LICENSE,sha256=lw44GXFG_Q0fS8m5VoEvv_xtdBXK26pBcbSPUCXee_Q,1078
-biblicus-0.1.1.dist-info/METADATA,sha256=lgvWJUgESiwWTCZ6_uUzgZeM3SkvnwjIzcsb8OE53BA,6635
-biblicus-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-biblicus-0.1.1.dist-info/entry_points.txt,sha256=BZmO4H8Uz00fyi1RAFryOCGfZgX7eHWkY2NE-G54U5A,47
-biblicus-0.1.1.dist-info/top_level.txt,sha256=sUD_XVZwDxZ29-FBv1MknTGh4mgDXznGuP28KJY_WKc,9
-biblicus-0.1.1.dist-info/RECORD,,