Metadata-Version: 2.3
Name: tbi-readgen
Version: 0.0.5
Summary: A README generator for Python projects
Project-URL: Homepage, https://github.com/TaiwanBigdata/readgen
Project-URL: Repository, https://github.com/TaiwanBigdata/readgen.git
Author-email: Albert Liu <dreamerhyde@gmail.com>
License: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# 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
```bash
$ pip install tbi-readgen

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

# Usage

## CLI
```bash
$ readgen

# Overwrite README.md.
$ readgen --f
```

## Project Configuration File
Create a `readgen.toml` file in the project root:
````toml
[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
```
"""


[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.
````

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