Advent of Code

• 2024
• 2023

Requirements

• You only need to have Poetry installed.

Important: Please run the make local-setup command before starting with the code.

In order to create a commit you have to pass the pre-commit phase which runs the check and test commands.

Folder structure

• There is a tests folder with the tests files.
  • In order to add new tests please follow the pytest recommendations.
• The production code goes inside the src folder.
• Inside the scripts folder you can find the git hooks files.

Project commands

The project uses Makefiles to run the most common tasks:

• check-typing: Runs a static analyzer over the code in order to find issues.
• check-format: Checks the code format.
• check-lint: Checks the code lint.
• format: Formats the code.
• lints: Lints the code.
• help : Shows this help.
• install: Installs the app packages.
• local-setup: Sets up the local environment (e.g. install git hooks).
• test: Run all the tests.
• watch: Run all the tests in watch mode.

Packages

This project uses Poetry as the package manager.

Testing

• pytest: Testing runner.
• pytest-xdist: Pytest plugin to run the tests in parallel.
• expects: An expressive and extensible TDD/BDD assertion library for Python..

Code style

• mypy: A static type checker.
• ruff: An extremely fast Python linter and formatter, written in Rust..