Metadata-Version: 2.1
Name: cptk
Version: 0.1.0a2
Summary: Your personal assistant for everything competitive-programming-related.
Home-page: https://github.com/RealA10N/cptk
Author: Alon Krymgand Osovsky
Author-email: downtown2u@gmail.com
License: UNKNOWN
Description: # Competitive Programming Tool Kit
        
        [![cptk](https://img.shields.io/static/v1?label=using&message=cptk&color=ffbb00)](https://github.com/RealA10N/cptk)
        [![PyPI](https://img.shields.io/pypi/v/cptk?logo=python&logoColor=white)](https://pypi.org/project/cptk)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/RealA10N/cptk/main.svg)](https://results.pre-commit.ci/latest/github/RealA10N/cptk/main)
        [![GitHub Workflow](https://img.shields.io/github/workflow/status/reala10n/cptk/CI/main?logo=github&logoColor=white)](https://github.com/RealA10N/cptk/actions/workflows/ci.yaml?query=branch%3Amain)
        [![codecov](https://img.shields.io/codecov/c/github/reala10n/cptk?logo=codecov&logoColor=white)](https://codecov.io/gh/RealA10N/cptk)
        
        **The Competitive Programming Tool Kit** (_cptk_ for short), is a command-line interface (CLI) that aims to be your personal assistant for everything competitive-programming-related. Some of the main features of cptk are:
        
        - Supports all large competitive programming websites, including [codeforces.com](https://codeforces.com/), [cses.fi](https://cses.fi/) and [kattis.com](https://open.kattis.com/)
        - Automatically download and run example test cases
        - Manage and catalog the solutions in your competitive programming folder
        - Full git integration: commits and pushes solutions after you submit them
        - And much more!
        
        **Are you using cptk?** Show us love and display the [![cptk](https://img.shields.io/static/v1?label=using&message=cptk&color=ffbb00)](https://github.com/RealA10N/cptk) badge in your repository!
        
        ## Getting started
        
        ### Installation
        
        The Competitive Programming Tool Kit is implemented fully in Python and is
        distributed using the Python Package Index (PyPI).
        
        To use cptk make sure you have **CPython>=3.7** installed.
        Then, install cptk using `pip`:
        
        ```shell
        pip install cptk
        ```
        
        You can check that the installation went successfully by running:
        
        ```shell
        cptk --help
        ```
        
        If you are experiencing problems while installing cptk, check out the more
        detailed [Installation Guide](https://github.com/RealA10N/cptk/wiki/Installation).
        
        
        # Changelog
        
        All notable changes to this project will be documented in this file.
        
        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
        
        ## [0.1.0a2] - 26.2.2022
        
        This alpha release adds the `cptk test` subcommand to cptk! 🥳
        
        Starting from this release the project configuration files supports a new
        field called `test`. It will be automatically created for you when you
        initialize a new cptk project using `cptk init`, and using it cptk will know
        where to store the scraped sample tests when cloning problems.
        
        By default, running `cptk test` will try and run the tests for the last problem
        that is known to cptk. It is also easy to add your custom test cases that will
        run when executing `cptk test`: just add `.in` and `.out` text files to the
        problem's testing folder!
        
        For more information and a full tutorial on the `cptk test` subcommand,
        you are more then welcome to visit our [wiki page](https://github.com/RealA10N/cptk/wiki).
        
        ### Added
        
        - The `cptk test` subcommand!
          - Optional `test` field for each recipe in the `recipes.cptk.yaml` configuration file
          - Optional `clone.recipe.test` field in the `project.cptk.yaml` configuration file
        
        
        ## [0.1.0a1] - 16.2.2022
        
        ### Fixed
        
        - Default templates are now bundled with the package,
          which fixes the bug in `cptk init`.
        
        ## [0.1.0a0] - 15.2.2022
        
        The first (alpha) release of cptk! 🥳
        Feel free to use the software and report any bugs that you find!
        Enjoy and have a nice day! 😃
        
        ### Added
        
        - Supported commands are: `cptk initialize`, `cptk clone`, `cptk move`,
          `cptk bake` and `cptk serve`.
        
        [0.1.0a2]: https://github.com/RealA10N/cptk/releases/tag/v0.1.0a2
        [0.1.0a1]: https://github.com/RealA10N/cptk/releases/tag/v0.1.0a1
        [0.1.0a0]: https://github.com/RealA10N/cptk/releases/tag/v0.1.0a0
        
Platform: UNKNOWN
Requires-Python: >=3.7,<4
Description-Content-Type: text/markdown
