Skip to content

Development

Contributing to and extending PILS.

Sections

  • Architecture

    System design and component overview

    Class hierarchy • Data flow • Design patterns

  • Testing

    Test-driven development practices

    pytest • Coverage • TDD workflow

  • Contributing

    How to contribute to PILS

    Git workflow • Pull requests • Code review

  • Adding Sensors

    Extend PILS with new sensor types

    Sensor interface • Registration • Examples

  • Code Style

    Coding standards and conventions

    Python style • Type hints • Documentation

  • Code Style

    Versioning rules for PILS

    Versioninig rules explained

Development Setup

# Clone repository
git clone https://github.com/polocalc/pils.git
cd pils

# Create conda environment
conda create -n dm python=3.10
conda activate dm

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest tests/ -v

# Format code
black pils/ tests/
isort pils/ tests/

See Also