A README generator for Python projects
Project description
ReadGen
A simple yet powerful Python project README.md generator.
Features
- Automatically scans project structure and generates directory descriptions
- Reads project settings from
project.yaml - Supports parsing
.env.exampleto generate environment variable documentation - Automatically extracts docstrings from init.py files in each folder
- Generates standardized Markdown format documentation
Installation
$ pip install tbi-readgen
# Recommendation, as it can be used globally.
$ pipx install tbi-readgen
Usage
Basic Usage
$ readgen
Project Configuration File
Create a project.yaml file in the project root:
project:
name: 'Project Name'
description: 'Project Description'
authors:
- name: 'Author Name'
email: 'email@example.com'
dependencies:
- python >= 3.7
- PyYAML >= 6.0.1
Compatibility
- Supports Python 3.7 and above
- Compatible with Windows, macOS, and Linux
License
This project is licensed under the MIT License. See the LICENSE file for details.
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
tbi_readgen-0.0.1.tar.gz
(5.7 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 tbi_readgen-0.0.1.tar.gz.
File metadata
- Download URL: tbi_readgen-0.0.1.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
667cfec18fa3b1578e1b6b3d556b6fcd4a92a6def7ccee6e89a682c27b095de6
|
|
| MD5 |
95f7ac8c0bdf859ead87ba676ca476ee
|
|
| BLAKE2b-256 |
8b86230fe487456bbc814e2907edee155e2c47671215c977ff09dcdfefe7adb1
|
File details
Details for the file tbi_readgen-0.0.1-py3-none-any.whl.
File metadata
- Download URL: tbi_readgen-0.0.1-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8726a3db8f7f0260098511fb48b054f57f8c377e7c7bb21e9d651865747eaffc
|
|
| MD5 |
c40f1ecf9f1fe4cc97770fb9f6986acf
|
|
| BLAKE2b-256 |
020e11bd10043b10dcea859e8f214f33f09f03e6e05b4812d7790de573eaefce
|
