# readme-generator
## Overview
This is a sample README generated by the script.
## Folder Structure
```
β£β π .github
β ββ π workflows
β ββ π python-publish.yml
β£β π readme_generator
β β£β π __init__.py
β β£β π emoji_map.py
β β£β π generate_readme.py
β β£β π readme_builder.py
β ββ π repo_structure.py
β£β π tests
β ββ π test_readme_generator.py
β£β π» .gitignore
β£β π install_package.sh
β£β βοΈ pyproject.toml
β£β π README.md
ββ π requirements.txt
```
## Files Description
* π `.github`: Contains configuration files for GitHub-specific workflows and actions.
- π `workflows`: Contains GitHub Actions workflows for automating tasks.
- π `python-publish.yml`: Contains GitHub Actions workflow configuration for automating Python package publishing.
* π `readme_generator`: Contains the main Python package for the project.
- π `__init__.py`: Marks the folder as a Python package.
- π `emoji_map.py`: Maps file types to corresponding emojis for visual representation.
- π `generate_readme.py`: Main script for generating the README file.
- π `readme_builder.py`: Handles the logic for constructing the README content.
* π `tests`: Contains test modules for the project.
- π `test_readme_generator.py`: Unit tests for the README generator functionality.
* π» `.gitignore`: Specifies files and directories to be ignored by Git.
* π `install_package.sh`: A shell script to install the package.
* βοΈ `pyproject.toml`: Configuration file for Python project dependencies and build system.
* π `README.md`: The generated README file for the project.
* π `requirements.txt`: Lists the Python dependencies required for the project.
## Installation
To install the package, run the following command:
```bash
pip install tree-readme
```
## Usage
To generate a README file, run the following command:
```bash
python -m readme_generator.generate_readme --repo-path "/path/to/your/repository" \
--overview "This is a sample README generated by the script." \
--exclude-dirs ".git" \
--exclude-dirs "__pycache__" \
--exclude-dirs ".idea" \
--exclude-dirs ".vscode" \
--exclude-dirs ".ipynb_checkpoints" \
--exclude-dirs ".egg-info" \
--exclude-dirs "dist" \
--exclude-dirs "_env" \
--exclude-dirs ".pytest_cache" \
--exclude-files ".pyc" \
--exclude-files ".pyo" \
--exclude-files ".pyd" \
--exclude-files ".DS_Store"
```
### Parameters
- `--repo_path`: Specifies the path to the repository for which the README will be generated (defaults to the current working directory).
- Example: `"/path/to/your/repository"`
- `--overview`: Provides a brief description of the project to include in the README (defaults to an empty string).
- Example: `"This is a sample README generated by the script."`
- `--exclude_dirs`: Lists directories to exclude from the repository structure in the README file (defaults to `.git`, `__pycache__`, `.idea`, `.vscode`, `.ipynb_checkpoints`, `.egg-info`, `dist`, `_env`, and `.pytest_cache`).
- Example: `.git readme_generator .vscode .idea .ipynb_checkpoints .egg-info dist _env .pytest_cache`
- `--exclude_files`: Lists file extensions or specific files to exclude from the repository structure in the README file (defaults to `.pyc`, `.pyo`, `.pyd`, and `.DS_Store`).
- Example: `.pyc .pyo .pyd .DS_Store`
### Python Version
It can also be run using the following python code:
```python
from pathlib import Path
from readme_generator.generate_readme import generate
repo_path = Path(__file__).resolve().parent
generate(
repo_path,
overview="This is a sample README generated by the script.",
exclude_dirs={".git", "__pycache__", ".idea", ".vscode", ".ipynb_checkpoints", ".egg-info", "dist", "_env", ".pytest_cache",},
exclude_files={".pyc", ".pyo", ".pyd", ".DS_Store"}
)
```
-------------------------------------------
**Last updated on 2025-06-07 20:36**
Raw data
{
"_id": null,
"home_page": null,
"name": "tree-readme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Jakub Ko\u015bcian <kuba.koscian001@gmail.com>",
"keywords": "readme, generator, python, project",
"author": null,
"author_email": "Jakub Ko\u015bcian <kuba.koscian001@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a1/32/b11c90c9383f6bae793700339f1d89a23ef1b8ff06b29166ff8a9fa27e1c/tree_readme-2.2.0.tar.gz",
"platform": null,
"description": "# readme-generator\n\n## Overview\nThis is a sample README generated by the script.\n\n## Folder Structure\n```\n\u2523\u2501 \ud83d\udcc1 .github\n\u2503 \u2517\u2501 \ud83d\udcc1 workflows\n\u2503 \u2517\u2501 \ud83d\udcdc python-publish.yml\n\u2523\u2501 \ud83d\udcc1 readme_generator\n\u2503 \u2523\u2501 \ud83d\udc0d __init__.py\n\u2503 \u2523\u2501 \ud83d\udc0d emoji_map.py\n\u2503 \u2523\u2501 \ud83d\udc0d generate_readme.py\n\u2503 \u2523\u2501 \ud83d\udc0d readme_builder.py\n\u2503 \u2517\u2501 \ud83d\udc0d repo_structure.py\n\u2523\u2501 \ud83d\udcc1 tests\n\u2503 \u2517\u2501 \ud83d\udc0d test_readme_generator.py\n\u2523\u2501 \ud83d\udc7b .gitignore\n\u2523\u2501 \ud83d\udc1a install_package.sh\n\u2523\u2501 \u2699\ufe0f pyproject.toml\n\u2523\u2501 \ud83d\udcd6 README.md\n\u2517\u2501 \ud83d\udcc3 requirements.txt\n```\n\n## Files Description\n* \ud83d\udcc1 `.github`: Contains configuration files for GitHub-specific workflows and actions.\n\t- \ud83d\udcc1 `workflows`: Contains GitHub Actions workflows for automating tasks.\n\t\t- \ud83d\udcdc `python-publish.yml`: Contains GitHub Actions workflow configuration for automating Python package publishing.\n* \ud83d\udcc1 `readme_generator`: Contains the main Python package for the project.\n\t- \ud83d\udc0d `__init__.py`: Marks the folder as a Python package.\n\t- \ud83d\udc0d `emoji_map.py`: Maps file types to corresponding emojis for visual representation.\n\t- \ud83d\udc0d `generate_readme.py`: Main script for generating the README file.\n\t- \ud83d\udc0d `readme_builder.py`: Handles the logic for constructing the README content.\n* \ud83d\udcc1 `tests`: Contains test modules for the project.\n\t- \ud83d\udc0d `test_readme_generator.py`: Unit tests for the README generator functionality.\n* \ud83d\udc7b `.gitignore`: Specifies files and directories to be ignored by Git.\n* \ud83d\udc1a `install_package.sh`: A shell script to install the package.\n* \u2699\ufe0f `pyproject.toml`: Configuration file for Python project dependencies and build system.\n* \ud83d\udcd6 `README.md`: The generated README file for the project.\n* \ud83d\udcc3 `requirements.txt`: Lists the Python dependencies required for the project.\n\n## Installation\n\nTo install the package, run the following command:\n\n```bash\npip install tree-readme\n```\n\n## Usage\n\nTo generate a README file, run the following command:\n\n```bash\npython -m readme_generator.generate_readme --repo-path \"/path/to/your/repository\" \\\n --overview \"This is a sample README generated by the script.\" \\\n --exclude-dirs \".git\" \\\n\t--exclude-dirs \"__pycache__\" \\\n\t--exclude-dirs \".idea\" \\\n\t--exclude-dirs \".vscode\" \\\n\t--exclude-dirs \".ipynb_checkpoints\" \\\n\t--exclude-dirs \".egg-info\" \\\n\t--exclude-dirs \"dist\" \\\n\t--exclude-dirs \"_env\" \\\n\t--exclude-dirs \".pytest_cache\" \\\n\t--exclude-files \".pyc\" \\\n\t--exclude-files \".pyo\" \\\n\t--exclude-files \".pyd\" \\\n\t--exclude-files \".DS_Store\"\n```\n\n### Parameters\n\n- `--repo_path`: Specifies the path to the repository for which the README will be generated (defaults to the current working directory).\n\t- Example: `\"/path/to/your/repository\"`\n\n- `--overview`: Provides a brief description of the project to include in the README (defaults to an empty string).\n\t- Example: `\"This is a sample README generated by the script.\"`\n\n- `--exclude_dirs`: Lists directories to exclude from the repository structure in the README file (defaults to `.git`, `__pycache__`, `.idea`, `.vscode`, `.ipynb_checkpoints`, `.egg-info`, `dist`, `_env`, and `.pytest_cache`).\n\t- Example: `.git readme_generator .vscode .idea .ipynb_checkpoints .egg-info dist _env .pytest_cache`\n\n- `--exclude_files`: Lists file extensions or specific files to exclude from the repository structure in the README file (defaults to `.pyc`, `.pyo`, `.pyd`, and `.DS_Store`).\n\t- Example: `.pyc .pyo .pyd .DS_Store`\n\n### Python Version\n\nIt can also be run using the following python code:\n\n```python\nfrom pathlib import Path\nfrom readme_generator.generate_readme import generate\n\nrepo_path = Path(__file__).resolve().parent\ngenerate(\n\trepo_path,\n\toverview=\"This is a sample README generated by the script.\",\n\texclude_dirs={\".git\", \"__pycache__\", \".idea\", \".vscode\", \".ipynb_checkpoints\", \".egg-info\", \"dist\", \"_env\", \".pytest_cache\",},\n\texclude_files={\".pyc\", \".pyo\", \".pyd\", \".DS_Store\"}\n)\n```\n\n-------------------------------------------\n**Last updated on 2025-06-07 20:36**\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple README generator for Python projects.",
"version": "2.2.0",
"project_urls": {
"repository": "https://github.com/kvbiii/tree-readme"
},
"split_keywords": [
"readme",
" generator",
" python",
" project"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "13776d558b1a6568f87a320b44203368e41b37b25d78872359a2463513f5af0d",
"md5": "4cb48dc5de59e79c80d621cf4c77cfda",
"sha256": "11a26de6618f96d7db6f33789fb63f9206323010d6db58ab50c3d3d4c4376145"
},
"downloads": -1,
"filename": "tree_readme-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cb48dc5de59e79c80d621cf4c77cfda",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6754,
"upload_time": "2025-07-30T17:56:41",
"upload_time_iso_8601": "2025-07-30T17:56:41.656945Z",
"url": "https://files.pythonhosted.org/packages/13/77/6d558b1a6568f87a320b44203368e41b37b25d78872359a2463513f5af0d/tree_readme-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a132b11c90c9383f6bae793700339f1d89a23ef1b8ff06b29166ff8a9fa27e1c",
"md5": "414cf908ab019412d343ebedcb0e5d16",
"sha256": "0aa9ecdd10c570241e2367b405f5ee67f981e6ee1c4e5ba7058315dba93f2e73"
},
"downloads": -1,
"filename": "tree_readme-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "414cf908ab019412d343ebedcb0e5d16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7401,
"upload_time": "2025-07-30T17:56:42",
"upload_time_iso_8601": "2025-07-30T17:56:42.862874Z",
"url": "https://files.pythonhosted.org/packages/a1/32/b11c90c9383f6bae793700339f1d89a23ef1b8ff06b29166ff8a9fa27e1c/tree_readme-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 17:56:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kvbiii",
"github_project": "tree-readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "typer",
"specs": [
[
"==",
"0.16.0"
]
]
}
],
"lcname": "tree-readme"
}
JSON
