README.md

Advent of Code Python Template for Copier

This template creates scaffolding for one day of Advent of Code. It includes tests and can download your personal input data if you have advent-of-code-data installed.

Note: You need at least version 6 of Copier to use this template.

Quick Start

The first time you use this template you should make sure that you have Copier installed and optionally advent-of-code-data as well. You can install these with pipx and pip:

$ pipx install copier
$ python -m pip install advent-of-code-data

Note that advent-of-code-data requires a small bit of setup where you find and specify your personal Advent of Code session ID. Once you have Copier on your system, you can create Advent of Code solution templates as follows:

$ copier gh:gahjelle/template-aoc-python advent_of_code/

This will ask you about which year and day you want to template. You can also provide a puzzle name which will be used as part of the directory name and the comments within your files.

The files are copied into a subdirectory of the advent_of_code/ directory on your computer. You can change advent_of_code/ to any other name you want.

Scripting

You can also use Copier as part of a script. The documentation shows how to call Copier as part of a Python script.

On the command line, you can use -d to provide answers to questions instead of answering them interactively. On Bash (and possibly other shells), the following will set up all directories for the 2021 event inside of your aoc/ directory:

$ for day in {01..25}; do
>     copier gh:gahjelle/template-aoc-python -d year=2021 -d day=$day -d puzzle_name="" -d puzzle_dir=$day aoc/
> done

If you're using Powershell on Windows, you can use something like this instead:

for ($day = 1; $day -le 25; $day++) {
    $day_str = "{0:00}" -f $day
    copier gh:gahjelle/template-aoc-python -d year=2021 -d day=$day_str -d puzzle_name="" -d puzzle_dir=$day_str aoc/
}

After running this, you'll have 25 subdirectories within aoc/2021/ with templates for solving each day of Advent of Code with Python.

Examples

See https://github.com/gahjelle/advent_of_code/tree/main/python for examples using the template. My tutorial, Advent of Code: Solving Your Puzzles With Python, explains the reasoning behind the template and shows a few examples of using it to solve puzzles.

Credits

Thanks to Matt Gregory for helping to debug this recipe for Windows and creating the Powershell script to create a full year of templates.

And a huge thanks to Eric Wastl for creating the wonderful Advent of Code.