Wagtail Vector Index
Wagtail Vector Index provides a way to turn Django models, Wagtail pages, and anything else in to embeddings which are stored in a one of multiple vector database backends.
This provides the backbone for features including:
- Natural language search
- Similarity search
- Content recommendations
Links
Supported Versions
- Wagtail 5.2
- Django 4.2
- Python 3.11, 3.12
Contributing
Install
To make changes to this project, first clone this repository:
git clone https://github.com/wagtail/wagtail-vector-index.git
cd wagtail-vector-index
With your preferred virtualenv activated, install testing dependencies:
Using pip
python -m pip install --upgrade pip>=21.3
python -m pip install -e .'[testing,llm,numpy,pgvector,qdrant,weaviate]' -U
Using flit
python -m pip install flit
python -m flit install -s
pre-commit
Note that this project uses pre-commit. It is included in the project testing requirements. To set up locally:
# go to the project directory
$ cd wagtail-vector-index
# initialize pre-commit
$ pre-commit install
# Optional, run all checks once for this, then the checks will run only on the changed files
$ git ls-files --others --cached --exclude-standard | xargs pre-commit run --files
How to run tests
Now you can run tests as shown below:
tox
or, you can run them for a specific environment tox -e py3.11-django4.2-wagtail5.2 or specific test
tox -e py3.11-django4.2-wagtail5.2 -- tests.test_file.TestClass.test_method
Sometimes tox contains cached dependencies, so if you want to run tests with the latest dependencies, you can use tox -r or run rm -rf .tox to delete the whole tox environment.
To run the test app interactively, use tox -e interactive, visit http://127.0.0.1:8020/admin/ and log in with admin/changeme.
Metadata
Release files for wagtail-vector-index 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wagtail_vector_index-0.10.0.tar.gz | 37.6 kB | Without provenance | Details for wagtail_vector_index-0.10.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wagtail_vector_index-0.10.0-py3-none-any.whl | Python 3 | none | any | Details for wagtail_vector_index-0.10.0-py3-none-any.whl |
Total release size: 77.2 kB
Release files / wagtail_vector_index-0.10.0.tar.gz
| Download URL | wagtail_vector_index-0.10.0.tar.gz |
|---|---|
| Size | 37.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
68dcd6865c46559e73aa75c6ea11b0870834f97b4c067d3a5b12f89df11b7eda
|
|
BLAKE2b-256 checksum How to use checksums |
672aa65eb3e7e4ebc1cdef95c501fb3b3b743a45618b0d841ac4f853b86a5021
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / wagtail_vector_index-0.10.0-py3-none-any.whl
| Download URL | wagtail_vector_index-0.10.0-py3-none-any.whl |
|---|---|
| Size | 39.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eabb8b039fee124cffca7db25065a622753950fddeff93a8305a3a2ffe322f0f
|
|
BLAKE2b-256 checksum How to use checksums |
ac236921ca4f258c13fe0465a23c7e183771f3c681ff1b3688f8bbca5fbf299a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for wagtail-vector-index 0.10.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.