Gives you an overview of your Project structure
Go to file
Falko Victor Habel 40e55ca55a
Gitea Actions For Tree-Structurer / Explore-Gitea-Actions (push) Successful in 22s Details
updated main
2025-02-09 11:46:02 +01:00
.gitea/workflows updated main 2025-02-09 11:46:02 +01:00
.vscode working generation script to generate proejct dirs with cli command create 2025-02-08 20:27:49 +01:00
src/prodir updated main 2025-02-09 11:46:02 +01:00
tests updated tests 2025-02-09 11:45:21 +01:00
.gitignore Initial commit 2025-01-18 21:37:27 +00:00
LICENSE Initial commit 2025-01-18 21:37:27 +00:00
README.md updated readme to work with nre name 2025-01-30 11:39:04 +01:00
example.py overhall, added proper source dir and and improved code to not need python anymore and renaming it 2025-01-30 11:37:49 +01:00
pyproject.toml updated tests 2025-02-09 11:45:21 +01:00
pytest.ini fianlized tests and fixed errors if needed. Including improved error handling 2025-01-20 15:43:23 +01:00
requirements-dev.txt added missing yaml files 2025-01-20 15:46:36 +01:00
setup.cfg fianlized tests and fixed errors if needed. Including improved error handling 2025-01-20 15:43:23 +01:00
setup.py updated main 2025-02-09 11:46:02 +01:00
test.txt updated tests 2025-02-09 11:45:21 +01:00

README.md

prodir

This is a Python package designed to display directory structures in a tree-like format. This tool provides an easy-to-read overview of the directory hierarchy, making it easier for developers to navigate complex project structures.

Installation

To install tree_structurer, you can use pip:

 pip install git+https://gitea.fabelous.app/Fabel/prodir.git

Usage

You can run tree_structurer from the command line. By default, it will analyze the current directory and print its structure in a tree-like format. You can also specify a path to another directory.

To display the directory structure of the current directory:

python -m prodir

or

prodir

To display the directory structure of a specific directory:

python -m prodir /path/to/directory

Options

  • -v or --verbose: Show more detailed output, including information about the path being analyzed.

Example:

python -m prodir /path/to/directory -v

Important Files and Folders Ignored

By default, prodir ignores files and folders that start with _ or .. However, it does include the following exceptions:

  • __init__.py and __main__.py files: These are considered important and will be included in the output.
  • Special folders like build, .git, node_modules, etc.: These are also ignored to keep the output focused on the essential parts of the directory structure.

Example Output

Analyzing directory: /path/to/directory:
├── main.py
├── module1
│   ├── __init__.py
│   └── submodule1.py
└── utils
    ├── helper.py
    └── constants.py