https://github.com/cutwell/readme-template

A template project / CLI tool for creating a README and other files for Python projects on GitHub.
https://github.com/cutwell/readme-template

cli command-line-tool python3 readme-generator readme-template

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cutwell/readme-template
• Owner: Cutwell
• License: mit
• Created: 2023-12-21T23:43:01.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2023-12-27T00:27:33.000Z (11 months ago)
• Last Synced: 2024-10-10T11:50:16.639Z (about 1 month ago)
• Topics: cli, command-line-tool, python3, readme-generator, readme-template
• Language: Python
• Homepage:
• Size: 2.91 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

#  README Template

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

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![PyPI](https://img.shields.io/pypi/v/readme-template-cli)](https://pypi.org/project/readme-template-cli/)

- 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.

[![Demo of the Read Me template command line app. It shows the user inputting their GitHub username and a repository name to generate a set of customised files useful for sharing GitHub projects.](demo.gif)](https://raw.githubusercontent.com/Cutwell/readme-template/main/demo.gif)

## Install

```sh

pip install readme-template-cli

```

## Usage

```sh

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`:

```sh

pip install -r requirements.txt

```

If using `poetry`:

```sh

poetry install --without dev

```

### Usage

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

If using `pip`:

```sh

python3 readme_generator/src/generator.py

```

If using `poetry`:

```sh

poetry run readme

```

## Contributing

For information on how to set up your dev environment and contribute, see [here](.github/CONTRIBUTING.md).

## License

MIT