A README generator for Python projects
Project description
ReadGen
一個簡單但強大的 Python 專案 README.md 自動產生工具。
功能特色
- 自動掃描專案結構並產生目錄說明
- 從 project.yaml 讀取專案設定
- 支援解析 .env.example 產生環境變數說明
- 自動擷取各資料夾 init.py 的 docstring
- 產生標準化的 Markdown 格式文件
安裝方式
pip install readgen
使用方法
基本使用
from readgen import ReadmeGenerator
# 建立產生器實例
generator = ReadmeGenerator()
# 產生 README 內容
readme_content = generator.generate()
# 內容會自動寫入專案根目錄的 README.md
專案設定檔
在專案根目錄建立 project.yaml：
project:
name: '專案名稱'
description: '專案描述'
authors:
- name: '作者名稱'
email: 'email@example.com'
dependencies:
- python >= 3.7
- PyYAML >= 6.0.1
相容性
Python 3.7 或以上版本 支援 Windows, macOS 和 Linux
授權條款
本專案採用 MIT License 授權。詳見 LICENSE 檔案。
貢獻指南
歡迎提交 Issue 和 Pull Request！
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.0.tar.gz
(5.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 tbi_readgen-0.0.0.tar.gz.
File metadata
- Download URL: tbi_readgen-0.0.0.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b968bd150d851abd503c49a4d4a8d93719f4903d9635029efced668c343fc8e
|
|
| MD5 |
f9e5e28e43210a86c7b8208375536695
|
|
| BLAKE2b-256 |
41ba22692669766e87ae10091608d8f5c1af862263d8dd2a54a8a43cdb568691
|
File details
Details for the file tbi_readgen-0.0.0-py3-none-any.whl.
File metadata
- Download URL: tbi_readgen-0.0.0-py3-none-any.whl
- Upload date:
- Size: 7.6 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 |
d20d74fb2a9325e2668a987b79d69c98d0c7f8dc5fce7f8362912f14d4f0865c
|
|
| MD5 |
6e05af9f4c2a0270af8ef412a018816b
|
|
| BLAKE2b-256 |
a16cc6f0c1b1119debe05c253aa2cfc4fd044b0595927673a486550bd0db6e15
|
