Skip to main content

A simple README generator for Python projects.

Project description

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
┣━ 📄 .gitignore
┣━ 📄 pyproject.toml
┣━ 📝 README.md
┗━ 📃 requirements.txt

Files Description

  • 📁 .github:
    • 📁 workflows:
      • ⚙️ python-publish.yml:
  • 📁 readme_generator:
    • 🐍 __init__.py:
    • 🐍 emoji_map.py:
    • 🐍 generate_readme.py:
    • 🐍 readme_builder.py:
    • 🐍 repo_structure.py:
  • 📄 .gitignore:
  • 📄 pyproject.toml:
  • 📝 README.md:
  • 📃 requirements.txt:

Installation

Usage


Last updated on 2025-05-09 22:48

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tree_readme-1.2.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tree_readme-1.2.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file tree_readme-1.2.0.tar.gz.

File metadata

  • Download URL: tree_readme-1.2.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tree_readme-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4de48d23bfb954fd3170fa9cc695b7557a97c65bd5e77b57b56a69dadf276130
MD5 c5b3eae0ad4ff35c2735daabc72aad5d
BLAKE2b-256 dc7daebe4131646672a39630a6bda6a5f1df3eda8005fbcdfa9ffe988ce4dc7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for tree_readme-1.2.0.tar.gz:

Publisher: python-publish.yml on kvbiii/tree-readme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tree_readme-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: tree_readme-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tree_readme-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c84a8321e083ca75140e356753b86ef557c230f0f165755ad4c665c058a8aad
MD5 39e4a14f4182e25f86702abc510c302c
BLAKE2b-256 29f831934f9941216708189ea7dac479349514f37b75e115fb8c3c7e2485ed3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for tree_readme-1.2.0-py3-none-any.whl:

Publisher: python-publish.yml on kvbiii/tree-readme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page