iscc-vdb

Warning

This project is in early development and not ready for production use.

The API and features are subject to significant changes. Use at your own risk.

Embedded Vector Database for ISCC

• Github repository: https://github.com/iscc/iscc-vdb/
• Documentation https://vdb.iscc.codes/

Prerequisites

• Python 3.10 or higher
• uv package manager

Installation

Install the environment and the pre-commit hooks:

uv run poe install

Available Commands

All development tasks can be run using poe:

uv run poe --help  # Show all available tasks
uv run poe install  # Install dependencies and pre-commit hooks
uv run poe check    # Run all code quality checks
uv run poe test     # Run tests
uv run poe docs     # Serve documentation locally
uv run poe build    # Build distribution packages

The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on PyPI.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

---

Repository initiated with fpgmaas/cookiecutter-uv.