Metadata-Version: 2.4
Name: fscribe
Version: 1.0.0
Summary: Cross-platform CLI tool to analyze and summarize project structures with SOLID design patterns
Author-email: Michael Luna <michael.luna37@proton.me>
License-Expression: MIT
Project-URL: Bug Reports, https://github.com/mluna030/fscribe/issues
Project-URL: Source, https://github.com/mluna030/fscribe
Keywords: cli,project-analysis,file-structure,cross-platform,async
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiofiles>=23.0.0
Requires-Dist: tqdm>=4.65.0
Requires-Dist: rich>=13.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: isort>=5.12.0; extra == "dev"
Requires-Dist: flake8>=6.0.0; extra == "dev"
Requires-Dist: mypy>=1.5.0; extra == "dev"
Requires-Dist: pre-commit>=3.0.0; extra == "dev"
Provides-Extra: packaging
Requires-Dist: PyInstaller>=5.13.0; extra == "packaging"
Requires-Dist: build>=0.10.0; extra == "packaging"
Requires-Dist: twine>=4.0.0; extra == "packaging"
Dynamic: license-file

# fscribe

**fscribe** is a command-line tool that summarizes file structures into formatted text, JSON, and Markdown for easier parsing and integration with LLMs.

## Features

- Generates a structured summary of directories and files
- Supports output in **text (`.txt`), JSON (`.json`), and Markdown (`.md`)**
- Uses **asynchronous processing** for efficient file reading
- Provides **file statistics**, including total files, total size, and detected programming languages
- Includes a **progress bar** for large projects
- Uses **colorized terminal output** for enhanced readability

## Installation

### Using `pip`
```sh
pip install fscribe
