Contributing

spacytextblob is happy to accept contributions from the community. Please review the guidelines below.

Development environment

uv is used to manage python dependencies. Run the following to install uv:

curl -LsSf https://astral.sh/uv/install.sh | sh

just is used to run scripts. See the just docs for instructions on how to install: https://github.com/casey/just.

just format

Please validate that all tests pass before submitting a PR by running:

# Test against the latest supported version of Python
just test

# Tet against all supported versions of Python
just test-matrix

To build the docs and visually inspect the docs please run:

just preview-docs