https://github.com/deepset-ai/document-store
https://github.com/deepset-ai/document-store
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/deepset-ai/document-store
- Owner: deepset-ai
- License: apache-2.0
- Created: 2023-08-03T14:26:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T08:24:22.000Z (about 1 year ago)
- Last Synced: 2024-05-01T09:24:33.282Z (about 1 year ago)
- Language: Python
- Size: 52.7 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/deepset-ai/document-store/actions/workflows/test.yml)
# Example Store
This Github repository is a template that can be used to create custom document stores to extend
the new [Haystack](https://github.com/deepset-ai/haystack/) API available from version 2.0.
## Template features
By creating a new repo using this template, you'll get the following advantages:
- Ready-made code layout and scaffold to build a custom document store.
- Support for packaging and distributing the code through Python wheels using Hatch.
- Github workflow to build and upload a package when tagging the repo.
- Github workflow to run the tests on Pull Requests.
## How to use this repo
1. Create a new repository starting from this template. If you never used this feature before, you
can find more details in [Github docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
2. If possible, follow the convention `technology-haystack` for the name of the new repository,
where `technology` can be for example the name of a vector database you're integrating.
3. Rename the package `src/example_store` to something more meaningful and adjust the Python
import statements.
4. Replace any occurrence of `example_store` and `example-store` across the repo, according
to the name you chose in the previous steps.
5. Search the whole codebase for the string `#FIXME`, that's where you're supposed to change or add
code specific for the database you're integrating.
6. If Apache 2.0 is not suitable for your needs, change the software license.
When your custom document store is ready and working, feel free to add it to the list of available
[Haystack Integrations](https://haystack.deepset.ai/integrations) by opening a Pull Request in
[this repo](https://github.com/deepset-ai/haystack-integrations).
## Test
You can use `hatch` to run the linters:
```console
~$ hatch run lint:all
cmd [1] | ruff .
cmd [2] | black --check --diff .
All done! ✨ 🍰 ✨
6 files would be left unchanged.
cmd [3] | mypy --install-types --non-interactive src/example_store tests
Success: no issues found in 6 source files
```
Similar for running the tests:
```console
~$ hatch run cov
cmd [1] | coverage run -m pytest tests
...
```
## Build
To build the package you can use `hatch`:
```console
~$ hatch build
[sdist]
dist/example_store-0.0.1.tar.gz
[wheel]
dist/example_store-0.0.1-py3-none-any.whl
```
## Release
To automatically build and push the package to PyPI, you need to set a repository secret called `PYPI_API_TOKEN`
containing a valid token for your PyPI account.
Then set the desired version number in `src/example_store/__about__.py` and tag the commit using the format
`vX.Y.Z`. After pushing the tag, a Github workflow will start and take care of building and releasing the package.
## License
`example-store` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.