Developer Guide

This guide provides information for developers who want to contribute to the AIBS Informatics AWS Utils library.

Development Setup

Prerequisites

• Python 3.10 or higher
• Git
• uv (for managing dependencies)
• Make (optional, but recommended)

Clone the Repository

git clone https://github.com/AllenInstitute/aibs-informatics-aws-utils.git
cd aibs-informatics-aws-utils

Install Dependencies

Using uv:

uv sync --group dev --group lint

Running Tests

Tests rely heavily on moto to mock AWS services:

# Run all tests
make test

# Run tests with coverage
make test-coverage

# Run specific test file
pytest test/aibs_informatics_aws_utils/test_s3.py

Code Quality

Linting

# Run ruff linter
make lint

# Auto-fix linting issues
make format

Type Checking

# Run mypy type checker
make lint-mypy

Building Documentation

# Serve documentation locally
make docs-serve

# Build documentation
make docs-build

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-feature)
3. Make your changes
4. Run tests and linting
5. Commit your changes (git commit -am 'Add my feature')
6. Push to the branch (git push origin feature/my-feature)
7. Create a Pull Request

Please see CONTRIBUTING.md for detailed guidelines.

Code Style

• Follow PEP 8 guidelines
• Use type hints for all function signatures
• Write docstrings in Google style format
• Keep functions focused and small
• Write tests for new functionality
• Mock AWS services using moto in tests