https://github.com/nymann/racoon
Python project generation tool using https://github.com/nymann/python-template
https://github.com/nymann/racoon
cookiecutter-python3 cookiecutter-template python3 template typer-cli
Last synced: 10 months ago
JSON representation
Python project generation tool using https://github.com/nymann/python-template
- Host: GitHub
- URL: https://github.com/nymann/racoon
- Owner: nymann
- License: mit
- Created: 2022-08-31T19:08:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T18:50:49.000Z (over 2 years ago)
- Last Synced: 2025-03-28T21:06:49.974Z (10 months ago)
- Topics: cookiecutter-python3, cookiecutter-template, python3, template, typer-cli
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Racoon
_View on [PyPI](https://pypi.org/project/py-racoon)_
## What is it?
A Python3 template initializer based on [nymann/python-template](https://github.com/nymann/python-template). That automatically sets up a GitHub project for you.
Example of generated project: [nymann/racoon-example](https://github.com/nymann/racoon-example)
## Installation
```sh
pip install py-racoon
```
## Usage
```sh
$ racoon --help
Usage: racoon [OPTIONS] URL
Arguments:
URL [required]
Options:
--access-token PATH [env var: GITHUB_ACCESS_TOKEN; default: /home/knj/.cache/github_token]
--src-dir TEXT [default: src]
--template-url TEXT [default: https://github.com/nymann/python-template.git]
--help Show this message and exit.
```
### Example
```sh
# Export your github access token file as an environment variable, can also be provided via --github-access-token
export GITHUB_ACCESS_TOKEN='YOUR_ACCESS_TOKEN'
# Create a new project "my-project" which will be created under https://github.com/YOUR_USERNAME/my-project
racoon my-project
```
## Development
For help getting started developing check [DEVELOPMENT.md](DEVELOPMENT.md)