README Template

A template project / CLI tool for creating a README and other files for Python projects on GitHub.

• This project contains templates you can use to write your own README, CONTRIBUTING and PULL_REQUEST_TEMPLATE files.
• It also includes a CLI tool for using these files in your own projects.
• Supports pip or poetry for dependency management.

Install

pip install readme-template-cli

Usage

readme [-h] [--test] [--force]

Flag	Description
-h, --help	Show this help message and exit.
--test	Run in test mode - files created have .test extension. This does not update filename references inside the templates.
--force	Force overwrite existing files.

Run locally

Install dependencies

If using pip:

pip install -r requirements.txt

If using poetry:

poetry install --without dev

Usage

Run the program from the command line (from the project root) like this:

If using pip:

python3 readme_generator/src/generator.py

If using poetry:

poetry run readme

Contributing

For information on how to set up your dev environment and contribute, see here.

License

MIT