indastructa 0.1.2

A CLI tool to generate ASCII tree representation of a project structure.

Indastructa

Indastructa is a convenient CLI tool for quickly creating a clear ASCII tree of your project's file structure.

Perfect for documentation, technical reviews, architecture discussions, or blog posts.

---

Key Features

• Zero Dependencies: Built using only Python's standard library. No external packages are needed, ensuring a fast, secure, and conflict-free installation.
• Clear Output: Generates a beautiful and easy-to-read ASCII tree.
• Automatic Saving: Results are automatically saved to a project_structure.txt file in the project root.
• Smart Exclusions: By default, ignores unnecessary files and folders (such as .git, venv, __pycache__, .idea, and others).
• Integration with .gitignore: Automatically reads rules from .gitignore and .dockerignore to exclude everything unrelated to source code.
• Flexible Configuration: Allows specifying target folder, limiting scan depth, and adding custom exclusions and inclusions via command-line arguments.

---

Installation

pip install indastructa

Advanced: Installing from TestPyPI (click to expand)

TestPyPI is our testing environment for validating releases before publishing to PyPI.

Versions there may be newer, older, or match the production release - use for testing purposes only.

To install from TestPyPI:

pip install -i https://test.pypi.org/simple/ indastructa

Latest test version: https://test.pypi.org/project/indastructa/

---

Usage

Basic Examples

Scan current directory:

indastructa

Scan specific directory:

indastructa ./src

Custom output file:

indastructa -o structure.txt

Advanced Options

Quiet mode (no console output):

indastructa --quiet

Preview without saving:

indastructa --dry-run

Limit scan depth:

indastructa --depth 2

Exclude single pattern:

indastructa --exclude "*.pyc"

Exclude multiple patterns:

indastructa --exclude "*.log,node_modules"

Force include single file (overrides exclude):

indastructa --include ".env"

Force include multiple files:

indastructa --include ".env,.secrets"

Combined Example

indastructa ./src --depth 3 --exclude "*.pyc,__pycache__" --include ".env" --quiet -o structure.md

Tips

• Use quotes around patterns with wildcards: "*.log"
• Separate multiple patterns with commas: "*.pyc,*.pyo"
• Files matching --include are shown even if they match --exclude
• Default output: project_structure.txt
• Default depth: unlimited (-1)

---

Exclusion Logic

indastructa uses a filtering system with the following priority:

1. --include rules: Highest priority. Matching files are always shown.
2. Built-in rules: Default exclusions like .git, venv, __pycache__, etc.
3. .gitignore and .dockerignore: Automatically loaded from your project.
4. --exclude rules: Additional patterns passed via command line.

---

Future Ideas

Planned features for upcoming releases:

• Selectable ignore files
• Interactive mode for step-by-step configuration
• Export to JSON/YAML formats
• Color-coded output
• Integration with project documentation generators

Have ideas or found a bug? Create an Issue on GitHub.

---

License

This project is distributed under the MIT License.