This repository contains the Python client for the TileDB Cloud Service.
See Quickstart section of the docs.
See https://tiledb-inc.github.io/TileDB-Cloud-Py/
Documentation uses Quarto style documentation.
- Install Quarto for your OS
- Install documentation dependencies:
pip install .[docs]
- Update the docs/_quarto.yaml file accordingly (read the quartodoc documentation on how to do that)
- Build the docs:
quartodoc build --config docs/_quarto.yaml
- Preview the generated docs:
quarto preview docs/
- Create a relevant PR
- Selection:
- All tests:
pytest
- All tests with verbosity:
pytest -vs
- Tests with
taskgraphs
in their names:pytest -vsk taskgraphs
- All tests:
- Credentials:
- These tests run on TileDB Cloud using your current environment variable
TILEDB_REST_TOKEN
-- you will need a valid API token for the tests to pass - For continuous integration, the token is configured for the
unittest
user and all tests should pass - For interactive use, if your
TILEDB_REST_TOKEN
points to your own account, most tests will run, except for those that explicitly check against contents of theunittest
account which are skipped
- These tests run on TileDB Cloud using your current environment variable
Releasing is entirely automated. Releases made on GitHub using tags that start with "v", like "v0.12.28", trigger sdist and wheel builds and upload of those distributions to the Python Package Index.