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,CONTRIBUTINGandPULL_REQUEST_TEMPLATEfiles. - It also includes a CLI tool for using these files in your own projects.
- Supports
piporpoetryfor 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
1 maintainer
Metadata
1 maintainer
Release files for readme-template-cli 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| readme_template_cli-0.1.3.tar.gz | 4.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| readme_template_cli-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.4 kB
Release files / readme_template_cli-0.1.3.tar.gz
| Download URL | readme_template_cli-0.1.3.tar.gz |
|---|---|
| Size | 4.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2cacd5e4bb4a3625a7667f186f67002f214385b47ed1d2e574334b13c0a64369
|
|
BLAKE2b-256 checksum How to use checksums |
2aaddc17a8049c536d2ff788dce119ba80e416af45e0f6e5d70538dbf823bc37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.9.2 Linux/5.15.133.1-microsoft-standard-WSL2
|
Release files / readme_template_cli-0.1.3-py3-none-any.whl
| Download URL | readme_template_cli-0.1.3-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c2196882e58de9cb9df2465cb54e34ac21ccdbfb70f4429fdbff339997b22c8b
|
|
BLAKE2b-256 checksum How to use checksums |
9562284f377d564b15d866211586b09286245ee7a6bb001aa1b70c49ada3017e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.9.2 Linux/5.15.133.1-microsoft-standard-WSL2
|
Security for readme-template-cli 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
