tbi-readgen 0.0.2

A README generator for Python projects

ReadGen (tbi-readgen)

A simple yet powerful Python project README.md generator.

Features

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

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

""" [settings]

The settings is a built-in method and will not be listed.

Exclude directories from scanning.

exclude_dirs = [".git", "venv", "pycache", ".venv", "env", "build", "dist"]

List the depth of directories, list all by default.

"src/readgen" = 0 # directory = depth "utils" = 1 # directory = depth

# Compatibility
Supports Python 3.12 and above
Compatible with Windows, macOS, and Linux

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