A framework-agnostic Python library to seamlessly integrate Apache Cassandra(R) with ML/LLM/genAI workloads.
Project description
cassIO
A framework-agnostic Python library to seamlessly integrate Apache Cassandra with ML/LLM/genAI workloads.
Note: this is currently an alpha release.
Users
Installation is as simple as:
pip install cassio
For example usages and integration with higher-level LLM frameworks such as LangChain, please visit cassio.org.
CassIO developers
Setup
To develop cassio
, we use poetry
pip install poetry
Use poetry to install dependencies
poetry install
Use cassio current code in other Poetry base projects
If the integration is Poetry-based (e.g. LangChain itself), you should get this
in your pyproject.toml
:
cassio = {path = "../../cassio", develop = true}
Then you do
poetry remove cassio # if necessary
poetry lock --no-update
poetry install -E all --with dev --with test_integration # or similar, this is for langchain
Inspired from this. You also need a recent Poetry for this to work.
Versioning
We are still at 0.*
. Occasional breaking changes are to be expected,
but please think carefully. Later, a stronger versioning model will be adopted.
Style and typing
Style is enforced through black
, linting with ruff
,
and typechecking with mypy
.
The code should run through make format
without issues.
Python version coverage
At the moment we try to run tests under Python3.8 and Python3.10 to try and
catch versions-specific issues
(such as the newer typing
syntax such as typeA | typeB
, illegal on 3.8).
Publishing
- Bump version in pyproject.toml
- Add to
CHANGES.txt
- Commit the very code that will be built:
git tag v<x.y.z>; git push origin v<x.y.z>
make build
poetry publish # (login to PyPI ...)
Testing
Please run tests (and add some coverage for new features). This is not
enforced other than to your conscience. Type make
for the available tests.
To run the full tests (except specific tests targeting Cassandra),
there's make test-all
.
Unit testing
make test-unit
Integration with the DB
Ensure the required environment variables are set (see for instance
the provided TEMPLATE.testing.env
).
You need at least one of either Astra DB or a
Cassandra (5+) cluster to use.
Launch the tests with either of:
make test-integration
make test-astra-integration
make test-cassandra-integration
make test-testcontainerscassandra-integration
The last three above specify TEST_DB_MODE
as either LOCAL_CASSANDRA
, TESTCONTAINERS_CASSANDRA
or
ASTRA_DB
. Refer to TEMPLATE.testing.env
for required environment variables in the specific cases.
Note: Ideally you should test with both Astra DB and one Cassandra, since some tests are skipped in either case.
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file cassio-0.1.10.tar.gz
.
File metadata
- Download URL: cassio-0.1.10.tar.gz
- Upload date:
- Size: 35.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.11.2 Linux/6.1.0-21-amd64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 577f0a2ce5898a57c83195bf74811dec8794282477eb6fa4debd4ccec6cfab98 |
|
MD5 | 136f01a970c05bbbd262ccce18d19c96 |
|
BLAKE2b-256 | 8800a9a3a958169677f5f713bb3ed5a4afc1baf7abd1e08f37acad718aa923db |
File details
Details for the file cassio-0.1.10-py3-none-any.whl
.
File metadata
- Download URL: cassio-0.1.10-py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.11.2 Linux/6.1.0-21-amd64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9eebe5f18b627d0f328de4dbbf22c68cc76dbeecf46d846c0277e410de5cb1dc |
|
MD5 | 64be0718e7d670a3e5b30e3a4f368039 |
|
BLAKE2b-256 | 73ae25347dca6ca4032d421cd674fdb35bb02985baf5dcb8cbfac0cc95dfae49 |