# 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
Raw data
{
"_id": null,
"home_page": null,
"name": "fscribe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cli, project-analysis, file-structure, cross-platform, async",
"author": null,
"author_email": "Michael Luna <michael.luna37@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/8b/c5/b68ae7426c33b1d643565e9c9f4ec7da8c53e8a34b34c225211663c26379/fscribe-1.0.0.tar.gz",
"platform": null,
"description": "# fscribe\n\n**fscribe** is a command-line tool that summarizes file structures into formatted text, JSON, and Markdown for easier parsing and integration with LLMs.\n\n## Features\n\n- Generates a structured summary of directories and files\n- Supports output in **text (`.txt`), JSON (`.json`), and Markdown (`.md`)**\n- Uses **asynchronous processing** for efficient file reading\n- Provides **file statistics**, including total files, total size, and detected programming languages\n- Includes a **progress bar** for large projects\n- Uses **colorized terminal output** for enhanced readability\n\n## Installation\n\n### Using `pip`\n```sh\npip install fscribe\n",
"bugtrack_url": null,
"license": null,
"summary": "Cross-platform CLI tool to analyze and summarize project structures with SOLID design patterns",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/mluna030/fscribe/issues",
"Source": "https://github.com/mluna030/fscribe"
},
"split_keywords": [
"cli",
" project-analysis",
" file-structure",
" cross-platform",
" async"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "95eee26ab8be0e481a9ec0838ec24ccefcc703b9ca93e0eeb6d402e6de7e91a1",
"md5": "79b0658ed2b70653b8b6b14041bcf13e",
"sha256": "7ca053c37532842df0b673fbf147278914a8bde03478b52ca99310b9c69bbe87"
},
"downloads": -1,
"filename": "fscribe-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79b0658ed2b70653b8b6b14041bcf13e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 15464,
"upload_time": "2025-08-20T23:40:39",
"upload_time_iso_8601": "2025-08-20T23:40:39.116997Z",
"url": "https://files.pythonhosted.org/packages/95/ee/e26ab8be0e481a9ec0838ec24ccefcc703b9ca93e0eeb6d402e6de7e91a1/fscribe-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8bc5b68ae7426c33b1d643565e9c9f4ec7da8c53e8a34b34c225211663c26379",
"md5": "1ac03aad9d6f7310f6882b59e33652f0",
"sha256": "71873afa0dd828f981044211c04298a6bacc11c44449267ea8e15731393acda7"
},
"downloads": -1,
"filename": "fscribe-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1ac03aad9d6f7310f6882b59e33652f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12987,
"upload_time": "2025-08-20T23:40:40",
"upload_time_iso_8601": "2025-08-20T23:40:40.320985Z",
"url": "https://files.pythonhosted.org/packages/8b/c5/b68ae7426c33b1d643565e9c9f4ec7da8c53e8a34b34c225211663c26379/fscribe-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 23:40:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mluna030",
"github_project": "fscribe",
"github_not_found": true,
"lcname": "fscribe"
}
JSON
