Bubble Analyser

[Description for project.]

This is a Python application that uses poetry for packaging and dependency management. It also provides pre-commit hooks (for ruff and mypy) and automated tests using pytest and GitHub Actions.

For developers

This is a Python application that uses poetry for packaging and dependency management. It also provides pre-commit hooks for various linters and formatters and automated tests using pytest and GitHub Actions. Pre-commit hooks are automatically kept updated with a dedicated GitHub Action.

To get started:

1. Download and install Poetry following the instructions for your OS.

2. Clone this repository and make it your working directory

3. Set up the virtual environment:

   poetry install

4. Activate the virtual environment (alternatively, ensure any Python-related command is preceded by poetry run):

   poetry shell

5. Install the git hooks:

   pre-commit install

6. Run the main app:

   python -m bubble_analyser