aind-python-library-template

This is a repository template to quickly setup a python library project. This repository utilizes a tool called uv to handle all dependency and package management. For more information on this tool go to the uv wiki.

Getting Started

• To use this template, click the green Use this template button and Create new repository.
• Install uv

Tools

Package/Project Management

This project utilizes uv to handle installing dependencies as well as setting up environments for this project. It replaces tool like pip, poetry, virtualenv, and conda.

This project also uses tox for orchestrating multiple testing environments that mimics the github actions CI/CD so that you can test the workflows locally on your machine before pushing changes.

Code Quality Check

The following are tools used to ensure code quality in this project.

• Unit Testing

uv run pytest tests

• Linting

uv run ruff check

• Type Check

uv run mypy src/mypackage

Documentation

To generate the rst files source files for documentation, run

sphinx-apidoc -o docs/source/ src

Then to create the documentation HTML files, run

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