aocf

Crates.ioaocf
lib.rsaocf
version0.1.21
sourcesrc
created_at2020-01-12 05:45:21.338285
updated_at2022-12-19 16:50:57.737488
descriptionA crate and CLI helper tool for Advent of Code
homepage
repositoryhttps://github.com/nuxeh/aocf
max_upload_size
id197679
size4,034,453
nuxeh (nuxeh)

documentation

README

aocf - Advent of Code fetch

build test clippy macOS windows coveralls crates.io crates.io

A CLI tool (and also crate) for Advent of Code.

demo

Written in Rust, but the CLI should be useful for development in any language.

To use directly within Rust, the crate may be used as follows, for getting input data for a task as a string:

use aocf::Aoc;

fn main() {
    let mut aoc = Aoc::new()
        .year(Some(2020))
        .day(Some(1))
        .init()
        .unwrap();

    // Get input data (don't force)
    let input = aoc.get_input(false);

    if let Ok(i) = input {
        println!("{}", i);
    }
}

Documentation for the Aoc structure can be found here.

Downloaded data is cached as JSON and queried each time the Aoc is initialised, to avoid unecessary requests.

The CLI has a workflow similar to Git, e.g.

$ aocf init
$ aocf get-cookie # get cookie from firefox cookie store
$ aocf set-cookie <your-cookie-text>
$ aocf checkout 1 2019
$ aocf checkout --now
$ aocf fetch
$ aocf brief --pretty
$ aocf input
$ aocf status
$ aocf submit <answer>

More details can be found in in the CLI's readme.

The CLI can be used even if you don't plan to solve problems in Rust, and the CLI and the crate can also be freely used together, so if there is a root configuration created by the CLI, the crate will find and use this, or else store cached data in the current directory.

How to get your session cookie. This can be as easy as logging in to AoC with Firefox, and having the CLI extract the authentication token automatically.

Installation

Install Rust

Install aocf:

  • cargo install aocf_cli.
  • cargo install --path . from inside a cloned repository.
  • cargo deb --install from inside a cloned repository.

Dependencies

Depends on development packages for openssl, sqlite dependencies are bundled.

Commit count: 274

cargo fmt