Submarine - Advent of code 2021

This christmas we will celebrate inside a well equipped Pythonic submarine. 🌊

Welcome to the home of submarine, a Python library that aims to provide you with all the tools to solve the intricate puzzles put forth on this edition of advent of code!

Setup

If you like poetry go for

poetry install

otherwise you are most welcome with pip to

pip install -r requirements.txt

Run

Most of the magic happens in the Jupyter Notebooks inside /solutions so go have a look!

Dev

The source code for submarine lives under the /submarine folder and its structure is currently work in progress.

Test

Testing is a bit barebones but if it passes it's the best news!

The principle is simple, run ALL the notebooks inside solutions/ and if none crashes... you win! Perform this test now yourself by running:

python3 run_all_tests.py

Build

We love poetry so you know what to do 🔥

poetry build