adventkit


Nameadventkit JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummarySolutions to Advent of Code puzzles.
upload_time2023-12-02 08:30:37
maintainer
docs_urlNone
author
requires_python>= 3.6.1
license
keywords advent of code puzzles
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Adventkit -- Advent of Code in Python
=====================================

These are my solutions in Python to some of the [Advent of Code
puzzles](https://adventofcode.com). My goal is to make the code readable
while also making it reasonably fast.

Installation
------------

You can install Adventkit using pip:

    pip install adventkit

Alternatively, after cloning the Adventkit repository, the code can be
run as is.

Requirements
------------

-   Python 3.6.1+
-   Puzzle input files placed in the right locations: the input for day
    1 of Advent of Code 2019 is read from `input/year2019/day01.txt`
    (relative to the current working directory).

Optional, to run `src/run.sh` after cloning the repository:

-   A POSIX-compliant shell (`/bin/sh`)
-   A shell command `python3` to run Python 3.6.1+ (any implementation)
-   If extra speed is desired on selected puzzles: A shell command
    `pypy3` to invoke PyPy 3.6+

How to run
----------

After installing Adventkit, you can run a single day's solver like this:

    adventkit 2019 10

Cloning the repository gives you more options:

-   Run a single day's solver: `src/run.sh 2019 10` (or
    `python3 src/run.py 2019 10`)
-   Run all solvers: `src/run.sh`
-   Run all solvers from one year: `src/run.sh 2019`

When invoked with the optional argument `--time`, `src/run.sh` prints
the execution time for each day. If the command `pypy3` invokes a
suitable version of PyPy, `src/run.sh` uses it for any solvers that are
expected to run faster under PyPy than CPython.

Testing
-------

To run the tests, first install
[`pytest`](https://pypi.org/project/pytest/) and
[`pytest-subtests`](https://pypi.org/project/pytest-subtests/), as well
as your local copy of `adventkit`. Then run the command `pytest`.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adventkit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">= 3.6.1",
    "maintainer_email": "Lukas Gelbmann <me@lukasgelbmann.com>",
    "keywords": "Advent of Code,puzzles",
    "author": "",
    "author_email": "Lukas Gelbmann <me@lukasgelbmann.com>",
    "download_url": "https://files.pythonhosted.org/packages/e0/8d/1828360073cf8be26a91490b7f863af755eb35aa4841145220fc8e493ad5/adventkit-0.2.0.tar.gz",
    "platform": null,
    "description": "Adventkit -- Advent of Code in Python\n=====================================\n\nThese are my solutions in Python to some of the [Advent of Code\npuzzles](https://adventofcode.com). My goal is to make the code readable\nwhile also making it reasonably fast.\n\nInstallation\n------------\n\nYou can install Adventkit using pip:\n\n    pip install adventkit\n\nAlternatively, after cloning the Adventkit repository, the code can be\nrun as is.\n\nRequirements\n------------\n\n-   Python 3.6.1+\n-   Puzzle input files placed in the right locations: the input for day\n    1 of Advent of Code 2019 is read from `input/year2019/day01.txt`\n    (relative to the current working directory).\n\nOptional, to run `src/run.sh` after cloning the repository:\n\n-   A POSIX-compliant shell (`/bin/sh`)\n-   A shell command `python3` to run Python 3.6.1+ (any implementation)\n-   If extra speed is desired on selected puzzles: A shell command\n    `pypy3` to invoke PyPy 3.6+\n\nHow to run\n----------\n\nAfter installing Adventkit, you can run a single day's solver like this:\n\n    adventkit 2019 10\n\nCloning the repository gives you more options:\n\n-   Run a single day's solver: `src/run.sh 2019 10` (or\n    `python3 src/run.py 2019 10`)\n-   Run all solvers: `src/run.sh`\n-   Run all solvers from one year: `src/run.sh 2019`\n\nWhen invoked with the optional argument `--time`, `src/run.sh` prints\nthe execution time for each day. If the command `pypy3` invokes a\nsuitable version of PyPy, `src/run.sh` uses it for any solvers that are\nexpected to run faster under PyPy than CPython.\n\nTesting\n-------\n\nTo run the tests, first install\n[`pytest`](https://pypi.org/project/pytest/) and\n[`pytest-subtests`](https://pypi.org/project/pytest-subtests/), as well\nas your local copy of `adventkit`. Then run the command `pytest`.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Solutions to Advent of Code puzzles.",
    "version": "0.2.0",
    "project_urls": {
        "Source": "https://github.com/LukasGelbmann/adventkit"
    },
    "split_keywords": [
        "advent of code",
        "puzzles"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45a7b2a5b449e68e283b13025ff2b1d39f90a14245efe8114d3db3d93208ccd2",
                "md5": "09269a380f942b593f13d8dc7879e3b3",
                "sha256": "a374214ccb87129d8c6c94b8b48a692cf0b02e743251d25a434019e1d52c3fe6"
            },
            "downloads": -1,
            "filename": "adventkit-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "09269a380f942b593f13d8dc7879e3b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">= 3.6.1",
            "size": 25913,
            "upload_time": "2023-12-02T08:30:35",
            "upload_time_iso_8601": "2023-12-02T08:30:35.435029Z",
            "url": "https://files.pythonhosted.org/packages/45/a7/b2a5b449e68e283b13025ff2b1d39f90a14245efe8114d3db3d93208ccd2/adventkit-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e08d1828360073cf8be26a91490b7f863af755eb35aa4841145220fc8e493ad5",
                "md5": "bcf4aee83107e6c654191c09e3d66877",
                "sha256": "89aa7192d11937108dcf72b80172934f42d5354d803d72933b2b449f71263785"
            },
            "downloads": -1,
            "filename": "adventkit-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bcf4aee83107e6c654191c09e3d66877",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">= 3.6.1",
            "size": 19637,
            "upload_time": "2023-12-02T08:30:37",
            "upload_time_iso_8601": "2023-12-02T08:30:37.618815Z",
            "url": "https://files.pythonhosted.org/packages/e0/8d/1828360073cf8be26a91490b7f863af755eb35aa4841145220fc8e493ad5/adventkit-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-02 08:30:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "LukasGelbmann",
    "github_project": "adventkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "adventkit"
}
        
Elapsed time: 0.14988s