AIND S3 Cache

Small library providing a transparent local cache for S3 objects.

Key Features

• S3 Integration: Built-in support for AWS S3 with caching and anonymous access
• Multi-source JSON Reading: Unified JSON loading from local files, HTTP URLs, and S3 URIs

Installation

If you choose to clone the repository, you can install the package by running the following command from the root directory of the repository:

pip install .

Otherwise, you can use pip:

pip install aind-s3-cache

To develop the code, run:

uv sync

Development

Please test your changes using the full linting and testing suite:

./scripts/run_linters_and_checks.sh -c

Or run individual commands:

uv run --frozen ruff format          # Code formatting
uv run --frozen ruff check           # Linting

uv run --frozen mypy                 # Type checking

uv run --frozen interrogate -v       # Documentation coverage
uv run --frozen codespell --check-filenames  # Spell checking
uv run --frozen pytest --cov  # Tests with coverage

Documentation

sphinx-build -b html docs/source/ docs/build/html

License

This project is licensed under the MIT License - see the LICENSE file for details.