This repository contains my solutions to the Advent of Code puzzles, written in Python. Solutions for different years will live in different directories:

• paoc/y22/solutions/day01.py
• paoc/y23/solutions/day02.py
• etc.

Having one repository is just something I like.

.
├── README.md
├── pyproject.toml
├── LICENSE
└── paoc
    ├── __init__.py
    ├── cli.py
    ├── constants.py
    ├── helper.py
    ├── play.ipynb
    ├── template.py
    └── y23
        ├── __init__.py
        ├── inputs
        │   ├── day01.txt
        │   └── ...
        ├── solutions
        │   ├── __init__.py
        │   ├── day01.py
        │   └── ...
        ├── answers.txt
        └── titles.txt

If you also want to participate in the Advent of Code, you could just #yolo it by creating loose .py files and running them manually. However, I've created this repository so everything is nice and neat, while still being able to focus on the puzzles themselves. If you're looking for a similar setup, here's how to get started.

First, fork the template branch of this repository and clone it to your local machine.

When you've got your own repo, make a virtual environment and install the paoc package:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -e .

Now find your cookie for the Advent of Code website and export it as an environment variable:

export AOC_COOKIE="your-cookie-here"

Also export the year you want to work on as two digits (I don't think I'll be around for the 22$^{\mathrm{nd}}$ century):

export AOC_YEAR="23"

The setup command will now create a directory for the year you specified, which should look like this:

./paoc/y23
        ├── __init__.py    [just a basic docstring]
        ├── titles.txt     [empty file]
        ├── answers.txt    [empty file]
        ├── input          [0 files]
        └── solutions      [0 files]

When you want to start for a new day, run the scaffold command with the day number as an argument:

scaffold 1

This will download the input for the day to input/day01.txt and create a file for your solution in solutions/day01.py.

It will also add the title of the puzzle to titles.txt (we use this for the docstring in the solution file) and for pretty printing the output.

Your solution file will be based off this template and should look something like this when parsed:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

""" AoC 23 Day 1 - Trebuchet?! """

from paoc.helper import get_input, print_summary


def p1() -> any:
    _ = get_input(1)

def p2() -> any:
    _ = get_input(1)


if __name__ == '__main__':
    print_summary(__file__, p1, p2)

Naturally, p1 and p2 will return your solutions to part 1 and 2 respectively.

Now, you could run the file manually with python3 paoc/y23/solutions/day01.py but that's not very fun.

Instead, you can use the solve command to run it for you:

solve 1

This will run both parts of the solution and print the output to the terminal, along with some info on the execution time.

If p2 doesn't return anything yet this will not break the code, it will just print None for part 2.

If you're a few days in, you can also run solve all to run all the solutions you've written so far.

For now, you will still have to manually copy the output to the AoC website to get your stars.