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 23:09

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.3.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.3.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tree_readme-1.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 d9d9e3962c9311f46b051f7572c234bf8949681b94c47961e62d424a5f21a7f8
MD5 a06acff20340a4a56b6e60c65c850612
BLAKE2b-256 8a564868d85bba756fac890b66f2c419a4b70052a1089143ac89b26acb69bddf

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: tree_readme-1.3.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a91f51398a999e39aecc0a26eca485a61cc0a5310e3c46ec5bafd295f1f2c842
MD5 041f7a5adedfc76da0b2ca3acb1327f5
BLAKE2b-256 768606836ac4cbb4eed5f7a3570005fa85a44f28e274f23fb0c494533dde8aa2

See more details on using hashes here.

Provenance

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