Advent of Code is an annual coding challenge by Eric Wastl. Some take up the challenge for the glory of the hall of fame. Others, like me, use the daily puzzles as a way of learning a new language. And so, this project is the story of my journey into Python - the language, the ecosystem and the whole Pythnoic world. Blended with years of experience as a Software Engineer, the aim is to compose solutions that are elegant, robust and fully tested. Oh, and deployed as a RESTful API using Flask, AWS Lambda, with Github Actions providing for a CI/CD pipleline with automated test, build and deploy functionality. Free to try it out below, just don't spoil your fun by using the API until you've solved the puzzle by yourself!!!
- Python 3.10-3.12
- AWS SAM CLI and AWS Credentials
- AWS Credentials - locally or as secrets for Github Action
pip install advent_of_code_solver@git+https://github.com/pjd199/advent_of_code_pythongit clone https://github.com/pjd199/advent_of_code_python
pip install --editable .[dev]Deployment requires AWS Lambda and Amazon Simple Storage Service (Amazon S3), both of which included in the AWS Free Tier. Usage outside the free tier may be charged.
- Build the app with SAM
sam build
- Deploy to AWS, using the --guided option on the first call to set stack names and locations, which will be saved in samconfig.toml
sam deploy --guided
If you encounter problems during deployment, the AWS SAM Hello World tutorial has a good troubleshooting section.
If AWS stack is no longer required, run:
sam delete
An deployment of the RESTful API for this project is available at https://api.adventofcode.dibdin.me/. If installed and deployed by another user, use the URL provided at the end of the SAM deploy process.
The resource endpoints for this API are:
- / - the root resource, listing of all resources available on this API
- /calendars - the calendar resource, listing valid puzzle years and days
- /puzzles - the puzzles resouce, detailing of all the puzzles
- /answers - the answers resource, to find the answer to a specific puzzle
- /system - the system resource, providing information about the API system
The body of the response is in JSON format, with the HTTP header containing one of the following standard status codes:
- 200 - success
- 404 - no solver for requested date or path does not exist
- 500 - server error, including errors in the puzzle input file
The root resource, listing of all resources available on this API
curl http://api.adventofcode.dibdin.me{
"api_version": "2.0.0",
"description": "Discover resourses available through this API.",
"links": [
{
"action": "GET",
"description": "Discover available puzzles and answers, filtered using /calendars/{year}.",
"href": "api.adventofcode.dibdin.me/calendars",
"rel": "calendars"
},
{
"action": "GET",
"description": "Discover detailed puzzle information, filtered using /puzzles/{year}/{day}.",
"href": "api.adventofcode.dibdin.me/puzzles",
"rel": "puzzles"
},
{
"action": "GET",
"description": "Find answer for given input by calling /answers/{year}/{day} with puzzle input as POST body or URL provided as input paramerater.",
"href": "api.adventofcode.dibdin.me/answers",
"parameters": ["input"],
"rel": "answers"
},
{
"action": "POST",
"description": "Find answer for given input by calling /answers/{year}/{day} with puzzle input as POST body or URL provided as input paramerater.",
"href": "api.adventofcode.dibdin.me/answers",
"rel": "answers"
}
],
"results": ["calendars", "puzzles", "answers"],
"self": "http://api.adventofcode.dibdin.me",
"timestamp": "2023-07-31T11:23:33Z"
}The calendars resource, listing valid puzzle years and days. Filtered using /calendars/{year} (for example /calendar/2015).
curl https://api.adventofcode.dibdin.me/calendars{
"api_version": "2.0.0",
"description": "List of available puzzles, filtered using /calendars/{year}",
"links": [],
"results": [
{
"days": [
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
19, 20, 21, 22, 23, 24, 25
],
"links": [
{
"action": "GET",
"description": "Discover detailed puzzle information for 2015.",
"href": "http://api.adventofcode.dibdin.me/puzzles/2015",
"rel": "puzzles"
}
],
"year": 2015
},
{
"days": [1, 2],
"links": [
{
"action": "GET",
"description": "Discover detailed puzzle information for 2016.",
"href": "http://api.adventofcode.dibdin.me/puzzles/2016",
"rel": "puzzles"
}
],
"year": 2016
}
],
"self": "http://api.adventofcode.dibdin.me/calendars",
"timestamp": "2016-12-02T16:23:41Z"
}The puzzles resource, listing detailed puzzle information. Filtered using /puzzles/{year} or /puzzles/{year}/{day} (eg /puzzles/2022 or /puzzles/2022/25)
curl https://api.adventofcode.dibdin.me/puzzles/2015/1{
"timestamp": "2023-08-03T16:56:21Z",
"self": "http://api.adventofcode.dibdin.me/puzzles/2015/1",
"api_version": "2.0.0",
"description": "Detailed puzzle information, filtered using /puzzles/{year}/{day}",
"results": [
{
"year": 2015,
"day": 1,
"title": "Not Quite Lisp",
"excerpt": "Santa was hoping for a white Christmas, but his weather machine's \"snow\" function is powered by stars, and he's fresh out! To save Christmas, he needs you to collect fifty stars by December 25th.",
"has_part_one": true,
"has_part_two": true,
"part_one_solved": true,
"part_two_solved": true,
"completion_date": "2022-07-09T19:08:56+01:00",
"timings": {
"unit": "ms",
"parse": 6,
"part_one": 0,
"part_two": 0
},
"official_url": "https://adventofcode.com/2015/day/1",
"repository_url": "https://github.com/pjd199/advent_of_code_python/blob/main/advent_of_code/year2015/day1.py",
"code_url": "https://github.com/raw/pjd199/advent_of_code_python/main/advent_of_code/year2015/day1.py",
"links": [
{
"rel": "answers",
"href": "http://api.adventofcode.dibdin.me/answers/2015/1",
"description": "Get the answer for 2015 day 1.",
"action": "GET",
"parameters": ["input"]
},
{
"rel": "answers",
"href": "http://api.adventofcode.dibdin.me/answers/2015/1",
"description": "Get the answer for 2015 day 1.",
"action": "POST"
}
]
}
],
"links": []
}Solve the puzzle for the requested year and day. There are two options for providing the puzzle input.
- The URL of a puzzle input file can be passed in using the input query parameter when requesting with the HTTP GET method.
curl https://api.adventofcode.dibdin.me/answers/2015/2?input=https://github.com/raw/pjd199/advent_of_code_python/main/puzzle_input/year2015/day2.txt- The puzzle input file can be uploaded using the HTTP POST method.
curl -X POST -H "Content-Type: text/plain" -d "@day2.txt" https://api.adventofcode.dibdin.me/answers/2015/2
{
"timestamp": "2023-07-31T10:32:54Z",
"self": "http://localhost:5000/answers/2015/2",
"api_version": "{version}",
"description": "Get the answer to the puzzle, with input file provide as POST, or URL provided as input paramerater.",
"results": {
"year": 2015,
"day": 2,
"part_one": "1598415",
"part_two": "3812909",
"timings": {
"units": "ms",
"parse": 5,
"part_one": 0,
"part_two": 0
}
},
"links": [
{
"rel": "puzzles",
"href": "http://api.adventofcode.dibdin.me/puzzles/2015/2",
"description": "Get the puzzle information for 2015 day 2.",
"action": "GET"
}
]
}The system resource, displaying useful system information.
{
"timestamp": "2023-08-24T13:18:34Z",
"self": "https://api.adventofcode.dibdin.me/system",
"api_version": "2.0.0",
"description": "System information.",
"results": {
"url": "https://api.adventofcode.dibdin.me/system",
"host": "api.adventofcode.dibdin.me",
"platform": "Linux-4.14.255-311-248.529.amzn2.aarch64-aarch64-with-glibc2.36",
"machine": "aarch64",
"architecture": "64bit",
"compiler": "CPython 3.12.0",
"license_url": "https://github.com/raw/pjd199/advent_of_code_python/main/license.md",
"license": "MIT"
},
"links": []
}This project includes a helper script for downloading the puzzle and input puzzle file from the Advent of Code website. It also creates a template Solver file for the puzzle, and updates the unit test.
To reduce requests to the Advent of Code website, a cache is created in the root of the project folder.
$ daily_helper 2015 1
For all the optional parameters, run
$ daily_helper --help
A session cookie is required to download answers and part two. To locate and store the session cookie:
- Open a web browser (Chrome, Edge or Mozilla)
- Log into the Advent of Code website
- Right click on the page, and select inspect
- On the application tab, select cookies
- Copy the value of the session cookie
- Store the session cookie using the following command
daily_helper --save_session <<<PASTE VALUE HERE>>
This project has unit tests, integration tests and system tests (which can only be run after the deployment phase).
pytest /tests/unit
pytest /tests/integration
pytest /tests/system- Test against multiple sets of puzzle input files
- Wait for Advent of Code to start on 1st December 2023!!!
Distributed under the MIT License. See licence.md for more information.
Pete Dibdin