knowledge-retrieval
knowledge_retrieval
📚 View Documentation | 🐛 Report a Bug | ✨ Request a Feature
Installation
You can install knowledge_retrieval via pip from PyPI:
pip install knowledge_retrieval
Installation for Development
To set up knowledge_retrieval for local development:
- Clone the repository:
git clone https://github.com/56kyle/knowledge-retrieval.git cd knowledge-retrieval
- Install dependencies using :term:
uv:uv sync - Install pre-commit hooks:
uvx nox -s pre-commit -- install
This sets up a virtual environment and installs core, development, and quality check dependencies.
Usage
(This section should explain how to use the generated application. Replace the content below with instructions specific to your project's functionality. If your project is a library, show import examples. If it's a CLI application, show command examples. Link to the full documentation for details.)
As a Library
# Example usage of your package as a library
# from knowledge_retrieval import some_function
# result = some_function()
# print(result)
As a Command-Line Application
If your project defines command-line entry points in pyproject.toml:
# Example usage of your CLI application
# knowledge-retrieval --help
# knowledge-retrieval do-something --input file.txt
For detailed API documentation and CLI command references, see the Documentation.
Development Workflow
This project uses a robust set of tools for development, testing, and quality assurance. All significant automated tasks are run via :term:Nox, orchestrated by the central noxfile.py.
- Run all checks (lint, typecheck, security):
uvx nox -s check - Run test suite with coverage:
uvx nox -s test - Build documentation:
uvx nox -s docs - Build package:
uvx nox -s build - See all available tasks:
uvx nox -l
Explore the noxfile.py and the project documentation for detailed information on the automated workflow.
Contributing
(This section should guide contributions to this specific generated project, not the template. It should refer to the project's CODE_OF_CONDUCT.md and link to a CONTRIBUTING.md specific to the project, if you choose to generate one.)
Report bugs or suggest features via the issue tracker.
See CONTRIBUTING.md for contribution guidelines.
License
Distributed under the terms of the MIT license. See LICENSE for details.
This project was generated from the cookiecutter-robust-python template.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file knowledge_retrieval-0.0.0.tar.gz.
File metadata
- Download URL: knowledge_retrieval-0.0.0.tar.gz
- Upload date:
- Size: 4.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1057af6b07f0fd6df44625c41718f2d70d5038ad34f65e2ac23c40972362e3bf
|
|
| MD5 |
371a29f4456f38d7962924ed21a1d777
|
|
| BLAKE2b-256 |
85034a870b355f33ef62af194c9900f0b4a45b636ee9f8cd18feee7623f84938
|
Provenance
The following attestation bundles were made for knowledge_retrieval-0.0.0.tar.gz:
Publisher:
release-python.yml on 56kyle/knowledge-retrieval
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
knowledge_retrieval-0.0.0.tar.gz -
Subject digest:
1057af6b07f0fd6df44625c41718f2d70d5038ad34f65e2ac23c40972362e3bf - Sigstore transparency entry: 2499646032
- Sigstore integration time:
-
Permalink:
56kyle/knowledge-retrieval@e52fa9a1053292c67bb9959c5539ef417b08edf6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/56kyle
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-python.yml@e52fa9a1053292c67bb9959c5539ef417b08edf6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file knowledge_retrieval-0.0.0-py3-none-any.whl.
File metadata
- Download URL: knowledge_retrieval-0.0.0-py3-none-any.whl
- Upload date:
- Size: 4.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80b077239d0dfe644695da2fe1fb64e472ec3ee3cc1f35f51dda162a38ddb573
|
|
| MD5 |
1df6d262a669189fbf30ff02b0555ae9
|
|
| BLAKE2b-256 |
45ddd7b2d960013d6884480f4e47fdf9b6f9fff84eae6457dfb70fa16801c5ba
|
Provenance
The following attestation bundles were made for knowledge_retrieval-0.0.0-py3-none-any.whl:
Publisher:
release-python.yml on 56kyle/knowledge-retrieval
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
knowledge_retrieval-0.0.0-py3-none-any.whl -
Subject digest:
80b077239d0dfe644695da2fe1fb64e472ec3ee3cc1f35f51dda162a38ddb573 - Sigstore transparency entry: 2499646048
- Sigstore integration time:
-
Permalink:
56kyle/knowledge-retrieval@e52fa9a1053292c67bb9959c5539ef417b08edf6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/56kyle
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-python.yml@e52fa9a1053292c67bb9959c5539ef417b08edf6 -
Trigger Event:
push
-
Statement type:
