tbi-readgen 0.0.8

A README generator for Python projects

ReadGen

This document was automatically generated by ReadGen as well!

tbi-readgen (0.0.8)

A simple yet powerful Python project README.md generator.

Features

1. Read project information from pyproject.toml
2. Read custom content from readgen.toml
   • Support variable substitution from pyproject.toml
   • Configure directory structure display with depth control
   • Toggle directory section display
3. Scan the project directory structure
4. Extract docstrings from __init__.py files in each folder
5. Generate a standardized README.md

Installation

$ pip install tbi-readgen

# Recommendation, as it can be used globally.
$ pipx install tbi-readgen

Usage

CLI

$ readgen

# Overwrite README.md.
$ readgen -f

Project Configuration File

Create a readgen.toml file in the project root:

[Title]
title = "Method to overwrite [Title], with support for spaces."
content = "Content of the Title Block"

[Markdown]
content = """
## This is a markdown block
1. Read project information from pyproject.toml
2. Read custom content from readgen.toml
3. Scan the project directory structure
4. Extract docstrings from `__init__.py` files in each folder
5. Generate a standardized README.md

```bash
$ pipx install tbi-readgen
```
"""

[Variables]
content = """
Examples of variables from pyproject.toml:
- Use ${project.version} to get the project version
- Use ${project.name} to get the project name
"""


[directory] # `directory` is a built-in method and will not be listed.
title = "Directory Structure" # You can customize block names to override the default "Directory Structure."
content = "123"
enable = true # If `enable = false`, it won't list all directories or scan the init instructions.
exclude_dirs = [".git", "venv", "__pycache__", ".venv", "env", "build", "dist"] # Exclude directories from scanning.
depth_limits = { "root" = 1, "root/mother" = 2 } # List the depth of directories, list all by default.

Development

Setup

git clone https://github.com/TaiwanBigdata/readgen.git
cd readgen
python -m venv env
source env/bin/activate  # Linux/Mac
pip install -e .

License

This project is licensed under the MIT License.

Directory Structure

• readgen
  • src
    • src/readgen
      • src/readgen/utils: This folder is primarily used for storing commonly used utilities.

---

This document was automatically generated by ReadGen.