README.md

🎄 Advent of Code

This repository contains different flavors of Python 3 code for the Advent of Code challenge, with configurations of the main tools used for ensuring programming best practices, maintainability and robustness.

Goals for this repository

Implementations

• short: the shortest implementation, counted as number of chars
• readable: the implementation you would be proud to commit to a production branch, linted, tested and documented
• uppingtheante: as a reference to this flair on the AoC subreddit, implementations where the input has been modified to become so huge that naive implementations cannot run in a reasonable time or with reasonable hardware

Quality / Performance / Best Practices

• pre-commit configuration
• tests passing
• 100% of code covered by tests
• flake8 static analysis
• mypy type checking
• performance counters for each implementation (particularly for uppingtheante ones)
• sphinx documentation
• ... with explanations of problem solving approach for each challenge

The package structure is copied from the awesome work by Marcel Blijleven in his own Advent of Code repository.