gendia
A Python CLI to generate a tree structured diagram for any directory!
Imagine this: you are on Discord and is request help from someone about a project you are working on. You want to show the structure of your project directory to the person. You can't just send a screenshot of the directory because it's too big and the person won't be able to see the whole structure. You can't just send a text file with the structure because it's too boring and the person won't be able to understand it easily. What do you do? You use gendia!
Heres an example of a tree structured diagram generated by gendia:
project
├── src
│ ├── main.py
│ ├── utils
│ │ ├── __init__.py
│ │ ├── helper.py
│ │ └── helper2.py
│ ├── tests
│ │ ├── __init__.py
│ │ ├── test_main.py
│ │ └── test_helper.py
│ └── README.md
├── LICENSE
└── .gitignore
Not just that, it is color coded! The directories are in blue, and different file types are in different colors. This makes it easier to understand the structure of the directory.
Installation
To add gendia to your project, run:
pip install gendia
This should install gendia to your project. You can now use it to generate tree structured diagrams for your directories.
Usage
To use gendia, run:
gendia path/to/directory
This should generate a tree structured diagram for the current working directory. You can also specify the output file by using the -o flag:
gendia -o output.txt
This should generate a tree structured diagram for the current working directory and save it to output.txt.
--hidden flag can be used to show hidden files and directories:
gendia --hidden
--depth flag can be used to specify the max depth of the foulders to go into, 1 being the lowest:
gendia --depth 1
-i flag enables icons, which are unicode/emoji characters that represent the file types. This is useful for quickly identifying the file types in the tree structure:
gendia -i
--exclude flag can be used to exclude certain files and directories from the tree structure. This is useful for excluding files and directories that are not relevant to the tree structure:
gendia --exclude .git,venv
Config files
Gendia's config file can reside in either of the 2 directory's:
~/gendia_config.ini
or
~/Scripts/gendia_config.ini
You can add the following contents to the file:
[settings]
exclude = .git,__pycache__,venv
The excluded files and foulders in the config file will be appended to the other excluded files you later specify with the --exclude flag.
1 maintainer
Metadata
1 maintainer
Release files for gendia 1.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| gendia-1.6.2.tar.gz | 6.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gendia-1.6.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.6 kB
Release files / gendia-1.6.2.tar.gz
| Download URL | gendia-1.6.2.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
478eb3f4e42611518269ee5a1e2d9ade01480690affc39d38ed3d748c91e9312
|
|
BLAKE2b-256 checksum How to use checksums |
ee555fd3e1140a6ffeb52b3f57adedc84cacc176e03b65e3d9edf72fffb5f1da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.0
|
Release files / gendia-1.6.2-py3-none-any.whl
| Download URL | gendia-1.6.2-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
67e7533b0f58e67a5d259a111ec54ccce69e327dbcbd9f9bd58470cdaa9b6ed0
|
|
BLAKE2b-256 checksum How to use checksums |
cc1a2ddd9f2bf96d75045e647f686369dd676ec51dbeed53bdee5de4619ac3cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.0
|
Security for gendia 1.6.2
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.
