A simple package to generate README files for projects automatically.
Project description
README Generator
A simple Python package to generate README files for projects automatically.
Features
- Automatically generates README files with customizable content.
Installation
pip install readme_gen
Usage
from readme_gen import generate_readme
generate_readme(
project_name="My Awesome Project",
description="This project is awesome because...",
installation_instructions="pip install -r requirements.txt",
usage_instructions="python main.py",
license_info="MIT License"
)
License
MIT License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
readme_gen-0.1.tar.gz
(1.8 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file readme_gen-0.1.tar.gz.
File metadata
- Download URL: readme_gen-0.1.tar.gz
- Upload date:
- Size: 1.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
921bd701e6e615a25d8b90c53c54a1bc1d82ef002fa9c7c2cba647040d3c26c5
|
|
| MD5 |
6cc8f16d2d2ba08c3b3363e980ec2023
|
|
| BLAKE2b-256 |
7b2aee9e42c89c175f3e394975e3bab401d953dd2fc306e15b5c3d7cde5a8a71
|
File details
Details for the file readme_gen-0.1-py3-none-any.whl.
File metadata
- Download URL: readme_gen-0.1-py3-none-any.whl
- Upload date:
- Size: 2.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f67e4617766d30b7cc64d6b2469890b655629af1a2118cdfcf5dab064d66606
|
|
| MD5 |
785361235df500f7af14dca778c38be5
|
|
| BLAKE2b-256 |
5c8d7e4ddf1bc9faf4846c848692774963a7ff7a7af3e2f3050bdae58af1d77a
|
