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:31

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.1.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.1.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tree_readme-1.1.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.1.0.tar.gz
Algorithm Hash digest
SHA256 b77673be13b3c8ebc6082172a262f957ad09f513a2670fbb61080d04e372eaf9
MD5 3b9dabdd6e7016f7f93ae84a6f1ad86e
BLAKE2b-256 8898f8d7af344f30581937c75a4a7d2c3fbb94f3dd01fd4fd39a06a55beccc35

See more details on using hashes here.

Provenance

The following attestation bundles were made for tree_readme-1.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: tree_readme-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed065e42f67d0215df2d5d2e3da01fadcac2abfeb9fefe7d7081532e991ddd09
MD5 7ae6e93726dae42a341d00264889e52e
BLAKE2b-256 3a213d4d96e0ad4b70c6eb978d93b617a7153f90002e9bdd3385ce3129e1e373

See more details on using hashes here.

Provenance

The following attestation bundles were made for tree_readme-1.1.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