🌳 TreeExporter

Automatically generate beautiful repository structure diagrams from your project.

No more manually maintaining folder trees in your README.

Why?

Keeping a repository structure up to date is surprisingly annoying.

Every time files or folders change, developers have to manually edit the tree inside the documentation:

src
├── api
├── models
├── utils
└── ...

Which quickly becomes outdated.

TreeExporter scans your project and generates a clean, automatically updated visualization instead.

It can be:

  • updated automatically with GitHub Actions
  • used as a Python library
  • used as a CLI tool
  • exported to SVG or plain text

🖼 Demo

SVG

Repository Structure

![Repository Structure](./structure.svg)

Text

Look at ./structure.txt

🚀 Features

  • Repository scanning
  • SVG export
  • Plain text export
  • Configurable excluded directories
  • GitHub Actions support
  • Python library API
  • Fast recursive traversal

More formats are planned.

Installation

WIP

💻 CLI

Generate a text tree:

tree-exporter

Generate SVG:

tree-exporter \
    --format svg \
    --output structure.svg

Exclude additional folders:

tree-exporter \
    --exclude ".venv,dist,build"

GitHub Actions

Automatically regenerate your repository structure on a schedule or after every push.

- uses: mrf0rtuna4/TreeExporter@master
  with:
    format: svg
    output: docs/structure.svg

Perfect for keeping documentation synchronized with your project.

Library

TreeExporter can also be used directly from Python.

from tree_exporter.config import ScanConfig
from tree_exporter.scanner import scan_repository

tree = scan_repository(
    ".",
    ScanConfig(),
)

Roadmap

  • ✅ Text export
  • ✅ SVG export
  • ✅ GitHub Action
  • 🔄 Themes
  • 🚧 Mermaid export
  • 🚧 JSON export
  • 🚧 PNG export
  • 🚧 Custom icons
  • 🚧 Ignore file support

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.2.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mrf0rtuna4 from gravatar.com mrf0rtuna4

License

Apache License

Requires

Python >=3.11

Report project as malware

Download files

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

Source Distribution

treeexporter-0.1.0.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

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

treeexporter-0.1.0-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file treeexporter-0.1.0.tar.gz.

File metadata

  • Download URL: treeexporter-0.1.0.tar.gz
  • Upload date:
  • Size: 34.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for treeexporter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e9ecc4c59d4b32681cfd4c446affc5ebcce7b74b6604a0b0fc176a474cd18e08
MD5 9e3bae41680929edfd2f7611c375f65c
BLAKE2b-256 d1210394585ce1e2aa8962f84b3eb2a2012676d90af88e50023dbfe5a776f6c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for treeexporter-0.1.0.tar.gz:

Publisher: publish.yml on mrf0rtuna4/TreeExporter

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

File details

Details for the file treeexporter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: treeexporter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for treeexporter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0524731f51efcb12de2dbd4cab167f254a655aa274d15b61440db459096f1204
MD5 24800844ba5eeb5f46c977101b7579a1
BLAKE2b-256 1486dfca8acae82f4153ae496b5d76a00fba2c06bcc16533c4b403031fb44cc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for treeexporter-0.1.0-py3-none-any.whl:

Publisher: publish.yml on mrf0rtuna4/TreeExporter

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

Release history Release notifications | RSS feed

0.2.0

2 files

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page