Skip to main content

Advent of Code helper CLI and library

Project description

Advent-of-code-py

Advent of Code helper CLI and library for python projects.

Note: Currently it is still in beta stage which may have lots of bug please report out bug if you find any

Status & Info:

Travis Build Status Code style License Project Version
Travis Build Status Code style License: MIT PyPI

Usage

Installation

To install out advent-of-code-py run out following command which install out advent-of-code-py cli and advent_of_code_py library.

pip install advent-of-code-py

OR

poetry add advent-of-code-py

Usage

Initially for advent-of-code-py to work out it need session value or session ID which you can obtain out by viewing out cookie while visiting advent of code server. After collecting session cookie value you need to add those value in config using advent-of-code-py CLI

advent-of-code-py config add <session-name> <session-value>

Now you can import out library by using

import advent_of_code_py

After importing a library you can now use out either two decorator solve or submit decorator for a function of puzzle

For example:-

@advent_of_code_py.submit(2018,3,1,session="<session-name>")
def puzzle_2018_3_1(input):
    # do some calculation
    return final_output

Now after decorating out function now you can call out function

puzzle_2018_3_1()

After calling out function final_output value will be submitted out to Advent of Code server for 2018 year day 3 problem then returns out whether submitted answer was correct or not. If session value is not provided then solution will be submitted to all session value set out.

You can also use out advent-of-code-py builtin Initializer and runner to create out appropriate CLI tool for problem so problem can be run easily To set advent-of-code-py puzzle as CLI

@advent_of_code_py.adventrunner()
def main_cli():
    initializer = advent_of_code_py.Initializer()
    initializer.add("<function_alias>"="<function>")
    # for example to run above function you can write out
    initializer.add("2018-3-1"=puzzle_2018_3_1)  
    # add other function
    return initializer

Now you can set out main_cli as entry points and it will create out CLI with appropriate name and function which was added. So for example to run out function puzzle_2018_3_1() you have to run out command as entry-point-name run 2018-3-1 which will run appropriate function as well as submit as desired.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for advent-of-code-py, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size advent_of_code_py-0.1.4-py3-none-any.whl (11.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size advent-of-code-py-0.1.4.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page