Skip to main content

pymermaid2dir

A Python package for converting directory structures to Markdown's Mermaid syntax.

pymermaid2dir is a Python package that allows you to convert directory structures into Markdown's Mermaid syntax, making it easy to visualize your file and folder hierarchy. With pymermaid2dir, you can easily generate diagrams and flowcharts that represent the structure of your project.

Installation

You can install pymermaid2dir using pip:

pip install pymermaid2dir

Usage

To use pymermaid2dir, simply run the pymermaid2dir module on the command line to convert the directory structure to mermaid.

usage: pymermaid2dir [-h] --folder FOLDER --output OUTPUT [-v]

pymermaid2dir

options:
  -h, --help            show this help message and exit
  --folder FOLDER, -f FOLDER
                        Input Root Folder
  --output OUTPUT, -o OUTPUT
                        Output Mode
  -v, --version         show program's version number and exit

Exsample

# command
python3 -m pymermaid2dir -f sample -o markdown

# result
\```mermaid
graph TD;
  28191270[sample]-->28191273[f1.txt];
  28191270[sample]-->28191278[f2.txt];
\```

Currently, only markdown output is available, so be sure to run with -o markdown.

License

pymermaid2dir is distributed under the MIT License. See the LICENSE file for more information.

We hope this helps you get started with your pymermaid2dir project on GitHub! Let us know if you have any other questions or if there's anything else we can do to assist you.

Metadata

Release files for pymermaid2dir 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymermaid2dir 1.0.0
File Size Uploaded Provenance Actions
pymermaid2dir-1.0.0.tar.gz 6.7 kB Without provenance Details for pymermaid2dir-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pymermaid2dir 1.0.0
File Interpreter ABI Platform Actions
pymermaid2dir-1.0.0-py3-none-any.whl Python 3 none any Details for pymermaid2dir-1.0.0-py3-none-any.whl

Total release size: 13.5 kB

Release files / pymermaid2dir-1.0.0.tar.gz

Download URL pymermaid2dir-1.0.0.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d330292bf8ff0fd26cf99cb560a1022f9de37a5d998235d9f6433131b9b65a64
BLAKE2b-256 checksum
How to use checksums
65c631683884da20160501647a047a79a75f040abd542768370c3d810e2b9305
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release files / pymermaid2dir-1.0.0-py3-none-any.whl

Download URL pymermaid2dir-1.0.0-py3-none-any.whl
Size 6.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e252cbb59b5a20d269beb8c11743b0f88031175966752396437a3a7ef08e87da
BLAKE2b-256 checksum
How to use checksums
0ec34ecda38a7a6ff20abd7c7a810aca84759577b5b9b6028c9e02c061bf78d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Security for pymermaid2dir 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

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