folderTree-cli 0.1.0__tar.gz

foldertree_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kaushal Kumar Jha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

foldertree_cli-0.1.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: folderTree-cli
+Version: 0.1.0
+Summary: Generate beautiful folder tree structures and project documentation.
+Author: Kaushal Kumar Jha
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Nikk-hub-code/folderTree
+Project-URL: Repository, https://github.com/Nikk-hub-code/folderTree
+Project-URL: Issues, https://github.com/Nikk-hub-code/folderTree/issues
+Keywords: folder-tree,tree,documentation,cli,filesystem,project,directory,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# FolderTree
+
+A lightweight command-line tool that automatically analyzes a project directory and generates clean, well-structured project documentation.
+
+FolderTree scans your project, collects metadata, analyzes project statistics, detects programming languages, generates a folder tree, and exports documentation in Markdown or TXT format.
+
+---
+
+## Features
+
+- 📁 Scan any project directory
+- 🌳 Generate a beautiful folder tree
+- 📊 Analyze project statistics
+- 💻 Detect programming languages
+- 📝 Generate project documentation
+- 📄 Export documentation as Markdown or TXT
+- ⚡ Fast and simple CLI interface
+
+---
+
+## Requirements
+
+- Python **3.11** or later
+
+---
+
+## Installation
+
+```bash
+pip install folderTree
+```
+
+After installation, the `folderTree` command will be available globally.
+
+---
+
+## Usage
+
+### Show available commands
+
+```bash
+folderTree --help
+```
+
+---
+
+### Generate documentation in the terminal
+
+```bash
+folderTree scan .
+```
+
+or
+
+```bash
+folderTree scan path/to/project
+```
+
+Example
+
+```bash
+folderTree scan sample_projects/python_project
+```
+
+---
+
+### Export as Markdown
+
+```bash
+folderTree scan . -o PROJECT_DOCUMENTATION.md
+```
+
+---
+
+### Export as TXT
+
+```bash
+folderTree scan . -o PROJECT_DOCUMENTATION.txt
+```
+
+---
+
+## Example Output
+
+```text
+# Project Documentation
+
+## Project Information
+
+- Project Name: folderTree
+- Project Location: D:\Projects\folderTree
+- Project Created: 2026-07-10
+- Documentation Generated: 2026-07-19
+
+## Statistics
+
+- Total Files: 59
+- Total Folders: 22
+- Total Size: 41.94 KB
+
+## Languages
+
+- Python: 47
+- Markdown: 4
+- TOML: 1
+- HTML: 1
+- CSS: 1
+- JavaScript: 1
+
+## Folder Structure
+
+folderTree/
+├── src/
+│   └── folderTree/
+├── tests/
+├── README.md
+├── LICENSE
+└── pyproject.toml
+```
+
+---
+
+## Project Structure
+
+```text
+folderTree/
+│
+├── src/
+│   └── folderTree/
+│       ├── analyzers/
+│       ├── cli/
+│       ├── exporters/
+│       ├── generators/
+│       ├── models/
+│       ├── scanner/
+│       └── utils/
+│
+├── tests/
+├── docs/
+├── README.md
+├── LICENSE
+├── CHANGELOG.md
+└── pyproject.toml
+```
+
+---
+
+## Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/Nikk-hub-code/folderTree.git
+```
+
+Move into the project directory:
+
+```bash
+cd folderTree
+```
+
+Install in editable mode:
+
+```bash
+pip install -e .
+```
+
+Run the test suite:
+
+```bash
+pytest
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License.

foldertree_cli-0.1.0/README.md

@@ -0,0 +1,178 @@
+# FolderTree
+
+A lightweight command-line tool that automatically analyzes a project directory and generates clean, well-structured project documentation.
+
+FolderTree scans your project, collects metadata, analyzes project statistics, detects programming languages, generates a folder tree, and exports documentation in Markdown or TXT format.
+
+---
+
+## Features
+
+- 📁 Scan any project directory
+- 🌳 Generate a beautiful folder tree
+- 📊 Analyze project statistics
+- 💻 Detect programming languages
+- 📝 Generate project documentation
+- 📄 Export documentation as Markdown or TXT
+- ⚡ Fast and simple CLI interface
+
+---
+
+## Requirements
+
+- Python **3.11** or later
+
+---
+
+## Installation
+
+```bash
+pip install folderTree
+```
+
+After installation, the `folderTree` command will be available globally.
+
+---
+
+## Usage
+
+### Show available commands
+
+```bash
+folderTree --help
+```
+
+---
+
+### Generate documentation in the terminal
+
+```bash
+folderTree scan .
+```
+
+or
+
+```bash
+folderTree scan path/to/project
+```
+
+Example
+
+```bash
+folderTree scan sample_projects/python_project
+```
+
+---
+
+### Export as Markdown
+
+```bash
+folderTree scan . -o PROJECT_DOCUMENTATION.md
+```
+
+---
+
+### Export as TXT
+
+```bash
+folderTree scan . -o PROJECT_DOCUMENTATION.txt
+```
+
+---
+
+## Example Output
+
+```text
+# Project Documentation
+
+## Project Information
+
+- Project Name: folderTree
+- Project Location: D:\Projects\folderTree
+- Project Created: 2026-07-10
+- Documentation Generated: 2026-07-19
+
+## Statistics
+
+- Total Files: 59
+- Total Folders: 22
+- Total Size: 41.94 KB
+
+## Languages
+
+- Python: 47
+- Markdown: 4
+- TOML: 1
+- HTML: 1
+- CSS: 1
+- JavaScript: 1
+
+## Folder Structure
+
+folderTree/
+├── src/
+│   └── folderTree/
+├── tests/
+├── README.md
+├── LICENSE
+└── pyproject.toml
+```
+
+---
+
+## Project Structure
+
+```text
+folderTree/
+│
+├── src/
+│   └── folderTree/
+│       ├── analyzers/
+│       ├── cli/
+│       ├── exporters/
+│       ├── generators/
+│       ├── models/
+│       ├── scanner/
+│       └── utils/
+│
+├── tests/
+├── docs/
+├── README.md
+├── LICENSE
+├── CHANGELOG.md
+└── pyproject.toml
+```
+
+---
+
+## Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/Nikk-hub-code/folderTree.git
+```
+
+Move into the project directory:
+
+```bash
+cd folderTree
+```
+
+Install in editable mode:
+
+```bash
+pip install -e .
+```
+
+Run the test suite:
+
+```bash
+pytest
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License.

foldertree_cli-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "folderTree-cli"
+version = "0.1.0"
+description = "Generate beautiful folder tree structures and project documentation."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+
+authors = [
+    { name = "Kaushal Kumar Jha" }
+]
+
+keywords = [
+    "folder-tree",
+    "tree",
+    "documentation",
+    "cli",
+    "filesystem",
+    "project",
+    "directory",
+    "python"
+]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development",
+    "Topic :: Utilities",
+]
+
+license-files = ["LICENSE"]
+
+[project.urls]
+Homepage = "https://github.com/Nikk-hub-code/folderTree"
+Repository = "https://github.com/Nikk-hub-code/folderTree"
+Issues = "https://github.com/Nikk-hub-code/folderTree/issues"
+
+[project.scripts]
+folderTree = "folderTree.cli.main:main"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

foldertree_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

foldertree_cli-0.1.0/src/folderTree/__main__.py

@@ -0,0 +1,5 @@
+from .cli.main import main
+
+
+if __name__ == "__main__":
+    main()

foldertree_cli-0.1.0/src/folderTree/analyzers/languages.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from folderTree.models import Folder, Project
+from folderTree.utils.constants import EXTENSION_TO_LANGUAGE
+
+
+@dataclass(slots=True)
+class LanguageStatistics:
+    """
+    Stores language statistics for a project.
+    """
+
+    language_counts: dict[str, int] = field(default_factory=dict)
+
+
+class LanguageAnalyzer:
+    """
+    Analyzes programming languages used in a project.
+    """
+
+    def analyze(self, project: Project) -> LanguageStatistics:
+        """
+        Analyze the project and return language statistics.
+        """
+
+        statistics = LanguageStatistics()
+
+        self._walk_folder(
+            project.root_folder,
+            statistics,
+        )
+
+        return statistics
+
+    def _walk_folder(
+        self,
+        folder: Folder,
+        statistics: LanguageStatistics,
+    ) -> None:
+        """
+        Recursively walk through folders.
+        """
+        # Process files in the current folder
+        for file in folder.files:
+
+            language = EXTENSION_TO_LANGUAGE.get(
+                file.extension.lower(),
+                "Unknown",
+            )
+
+            file.language = language
+
+            statistics.language_counts[language] = (
+                statistics.language_counts.get(language, 0) + 1
+            )
+
+        # Recursively process subfolders
+        for subfolder in folder.folders:
+
+            self._walk_folder(
+                subfolder,
+                statistics,
+            )

foldertree_cli-0.1.0/src/folderTree/analyzers/statistics.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from folderTree.models import Folder, Project
+
+
+@dataclass(slots=True)
+class Statistics:
+    """
+    Stores statistics about a scanned project.
+    """
+
+    total_files: int = 0
+    total_folders: int = 0
+    total_size: int = 0
+
+    extension_counts: dict[str, int] = field(default_factory=dict)
+
+
+class StatisticsAnalyzer:
+    """
+    Analyzes a Project and generates statistics.
+    """
+
+    def analyze(self, project: Project) -> Statistics:
+        """
+        Analyze a project and return statistics.
+        """
+
+        statistics = Statistics()
+
+        self._walk_folder(
+            project.root_folder,
+            statistics,
+        )
+
+        return statistics
+
+    def _walk_folder(
+        self,
+        folder: Folder,
+        statistics: Statistics,
+    ) -> None:
+        """
+        Recursively walk through folders and collect statistics.
+        """
+
+        # Count the current folder
+        statistics.total_folders += 1
+
+        # Process files in the current folder
+        for file in folder.files:
+
+            statistics.total_files += 1
+
+            statistics.total_size += file.size
+
+            extension = file.extension.lower()
+
+            statistics.extension_counts[extension] = (
+                statistics.extension_counts.get(extension, 0) + 1
+            )
+        
+        # Recursively process subfolders
+        for subfolder in folder.folders:
+            self._walk_folder(
+                subfolder,
+                statistics,
+            )

foldertree_cli-0.1.0/src/folderTree/cli/main.py

@@ -0,0 +1,66 @@
+from pathlib import Path
+
+from folderTree.exporters.markdown import MarkdownExporter
+from folderTree.exporters.txt import TXTExporter
+from folderTree.generators.documentation import DocumentationGenerator
+from folderTree.scanner.scanner import ProjectScanner
+from folderTree.cli.parser import create_parser
+
+
+def main() -> None:
+    """
+    Entry point for the FolderTree CLI.
+    """
+
+    parser = create_parser()
+
+    args = parser.parse_args()
+
+    if args.command == "scan":
+        scan(Path(args.path), args.output)
+
+
+def scan(
+    project_path: Path,
+    output: str | None,
+) -> None:
+    """
+    Scan a project and generate documentation.
+    """
+    scanner = ProjectScanner()
+
+    project = scanner.scan(project_path)
+
+    generator = DocumentationGenerator()
+
+    documentation = generator.generate(project)
+
+    if output is None:
+        print(documentation)
+        return
+
+    output_path = Path(output)
+
+    suffix = output_path.suffix.lower()
+
+    if suffix == ".md":
+        exporter = MarkdownExporter()
+
+    elif suffix == ".txt":
+        exporter = TXTExporter()
+
+    else:
+        raise ValueError(
+            f"Unsupported output format: {suffix}"
+        )
+
+    exporter.export(
+        documentation,
+        output_path,
+    )
+
+    print("✓ Documentation generated successfully.")
+    print(f"Output: {output_path}")
+
+if __name__ == "__main__":
+    main()

foldertree_cli-0.1.0/src/folderTree/cli/parser.py

@@ -0,0 +1,35 @@
+from argparse import ArgumentParser
+
+
+def create_parser() -> ArgumentParser:
+    """
+    Create and configure the FolderTree CLI parser.
+    """
+
+    parser = ArgumentParser(
+        prog="folderTree",
+        description="Generate project documentation.",
+    )
+
+    subparsers = parser.add_subparsers(
+        dest="command",
+        required=True,
+    )
+
+    scan_parser = subparsers.add_parser(
+        "scan",
+        help="Scan a project directory.",
+    )
+
+    scan_parser.add_argument(
+        "path",
+        help="Path to the project directory.",
+    )
+
+    scan_parser.add_argument(
+        "-o",
+        "--output",
+        help="Output file (.md or .txt).",
+    )
+
+    return parser