Metadata-Version: 2.1
Name: crackme-template
Version: 0.0.1
Summary: Crackme Template
Home-page: https://github.com/nymann/crackme-template
Maintainer: Kristian Nymann Jakobsen
Maintainer-email: kristian@nymann.dev
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer (>=0.4.1)
Requires-Dist: cookiecutter (>=1.7.3)
Requires-Dist: PyGithub (>=1.55)
Requires-Dist: crackmes-dl (>=1.0.4)
Provides-Extra: all
Requires-Dist: isort ; extra == 'all'
Requires-Dist: wemake-python-styleguide ; extra == 'all'
Requires-Dist: mypy ; extra == 'all'
Requires-Dist: black ; extra == 'all'
Requires-Dist: nitpick ; extra == 'all'
Requires-Dist: add-trailing-comma ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: pytest-mock ; extra == 'all'
Provides-Extra: dev
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: wemake-python-styleguide ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: nitpick ; extra == 'dev'
Requires-Dist: add-trailing-comma ; extra == 'dev'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'

# Crackme Template

Provided a github access token and a crackme-id (`https://crackmes.one/crackme/{crackme_id}`) as input, a github repository will be setup that intialises the template which includes the binary from the crackme.

## Usage

```sh
pip install crackme-template
crackme_template --crackme-id 5ec1a37533c5d449d91ae535 --github-access-token YOUR_TOKEN
```

Example of initialised repo: <https://github.com/nymann/crackme-baby-ransom/>

Note if `--github-access-token` is omitted the program will try to read it from the `GITHUB_ACCESS_TOKEN` environment variable.

## Development

For help getting started developing check [DEVELOPMENT.md](DEVELOPMENT.md)


