docgenie-cli 1.1.0__tar.gz

docgenie_cli-1.1.0/.gitignore

@@ -0,0 +1,131 @@
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo

docgenie_cli-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DocGenie Team
+
+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.

docgenie_cli-1.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: docgenie-cli
+Version: 1.1.0
+Summary: Auto-documentation tool that generates comprehensive README and HTML docs for any codebase.
+Project-URL: Homepage, https://github.com/ch1kim0n1/DocGenie
+Project-URL: Repository, https://github.com/ch1kim0n1/DocGenie
+Project-URL: Documentation, https://github.com/ch1kim0n1/DocGenie
+Project-URL: Changelog, https://github.com/ch1kim0n1/DocGenie/blob/main/CHANGELOG.md
+Author-email: DocGenie Team <contact@docgenie.dev>
+License: MIT License
+        
+        Copyright (c) 2025 DocGenie Team
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: gitpython>=3.1
+Requires-Dist: jinja2>=3.1
+Requires-Dist: markdown>=3.3
+Requires-Dist: pathspec>=0.9
+Requires-Dist: pygments>=2.10
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.25
+Requires-Dist: rich>=13.7
+Requires-Dist: structlog>=24.1
+Requires-Dist: toml>=0.10
+Requires-Dist: tree-sitter-language-pack>=0.13.0
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7; extra == 'dev'
+Requires-Dist: hypothesis>=6.0; extra == 'dev'
+Requires-Dist: mkdocs-material>=9.5; extra == 'dev'
+Requires-Dist: mkdocs>=1.5; extra == 'dev'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.6; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-markdown; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Requires-Dist: types-toml; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# DocGenie
+
+Auto-documentation tool that generates `README.md` and HTML docs for a codebase.
+
+## Quick Guide
+
+### Installation
+
+```bash
+python3 -m pip install "docgenie"
+```
+
+Requirements: **Python 3.10+**
+
+### Setup (from source)
+
+```bash
+git clone https://github.com/ch1kim0n1/DocGenie.git
+cd DocGenie
+python3 -m pip install -e "."
+```
+
+### Usage
+
+#### Generate Markdown README
+
+```bash
+docgenie generate /path/to/project --format markdown
+```
+
+#### Generate HTML Documentation
+
+```bash
+docgenie generate /path/to/project --format html
+```
+
+#### Generate Both Formats
+
+```bash
+docgenie generate /path/to/project --format both
+```
+
+#### Convert Existing README to HTML
+
+```bash
+docgenie html README.md --source readme --output docs.html
+# or, using the legacy convenience command:
+docgenie-html README.md --source readme --output docs.html
+```
+
+#### Programmatic Usage (Python API)
+
+```python
+from docgenie.core import CodebaseAnalyzer
+from docgenie.html_generator import HTMLGenerator
+
+analyzer = CodebaseAnalyzer('/path/to/project')
+data = analyzer.analyze()
+
+html_generator = HTMLGenerator()
+html_content = html_generator.generate_from_analysis(data, "output.html")
+```
+
+## Troubleshooting
+
+- Ensure all dependencies are installed
+- Check write permissions for output directory
+- Use UTF-8 encoding for source files
+
+## License
+
+MIT License. See LICENSE file for details.
+
+## What DocGenie Analyzes
+
+- **Project Structure**: Directory tree and file organization
+- **Source Code**: Functions, classes, methods, and documentation
+- **Dependencies**: Package files (requirements.txt, package.json, etc.)
+- **Configuration**: Config files and project settings
+- **Documentation**: Existing docs and README files
+- **Git Information**: Repository details, branches, contributors
+- **Statistics**: Language distribution, code metrics
+
+## Example Output
+
+DocGenie generates README files with:
+
+- **Project Overview**: Auto-generated description and features
+- **Installation Instructions**: Detected from your dependency files
+- **Usage Examples**: Based on your code structure
+- **API Documentation**: Extracted from functions and classes
+- **Project Structure**: Visual directory tree
+- **Dependencies**: Organized by package manager
+- **Contributing Guidelines**: Standard open-source templates
+
+## Advanced Usage
+
+### Command Line Options
+
+```bash
+# Basic usage
+docgenie --help                                 # Show help
+docgenie generate . --verbose                   # Enable detailed output
+docgenie generate . --force                     # Overwrite existing files
+
+# Format options
+docgenie generate . --format markdown           # README.md only (default)
+docgenie generate . --format html               # HTML documentation only
+docgenie generate . --format both               # Generate both README.md and HTML
+
+# Output options
+docgenie generate . --output custom_path        # Custom output location
+docgenie generate . --preview                   # Preview without saving
+
+# HTML converter
+docgenie html README.md --source readme         # Convert README to HTML
+docgenie html . --source codebase               # Generate HTML from code
+
+# Analysis tools
+docgenie analyze . --format json                # Output analysis as JSON
+docgenie init                                   # Create basic README template
+```
+
+### Configuration
+
+Create a `.docgenie.yaml` file in your project root:
+
+```yaml
+ignore_patterns:
+  - "*.log"
+  - "temp/*"
+  - "private/"
+
+template_customizations:
+  include_api_docs: true
+  include_directory_tree: true
+  max_functions_documented: 20
+```
+
+## Architecture
+
+DocGenie consists of several key components:
+
+- **CodebaseAnalyzer**: Multi-language code analysis engine with caching and concurrency
+- **ParserRegistry**: Pluggable parsers (AST, tree-sitter, regex fallback) per language
+- **ReadmeGenerator**: Jinja2-based template rendering system for markdown
+- **HTMLGenerator**: Beautiful HTML documentation generator with responsive design
+- **CLI Interface**: Typer + Rich powered user experience
+
+## Contributing
+
+We welcome contributions! Here's how to get started:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes and add tests
+4. Run the test suite (`pytest`)
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+### Development Setup
+
+```bash
+git clone https://github.com/ch1kim0n1/DocGenie.git
+cd DocGenie
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Thanks to all contributors who help make DocGenie better
+- Inspired by the need for better automated documentation tools
+- Built with love for the open-source community
+
+---
+
+If DocGenie helps you, please star this repository.

docgenie_cli-1.1.0/README.md

@@ -0,0 +1,183 @@
+# DocGenie
+
+Auto-documentation tool that generates `README.md` and HTML docs for a codebase.
+
+## Quick Guide
+
+### Installation
+
+```bash
+python3 -m pip install "docgenie"
+```
+
+Requirements: **Python 3.10+**
+
+### Setup (from source)
+
+```bash
+git clone https://github.com/ch1kim0n1/DocGenie.git
+cd DocGenie
+python3 -m pip install -e "."
+```
+
+### Usage
+
+#### Generate Markdown README
+
+```bash
+docgenie generate /path/to/project --format markdown
+```
+
+#### Generate HTML Documentation
+
+```bash
+docgenie generate /path/to/project --format html
+```
+
+#### Generate Both Formats
+
+```bash
+docgenie generate /path/to/project --format both
+```
+
+#### Convert Existing README to HTML
+
+```bash
+docgenie html README.md --source readme --output docs.html
+# or, using the legacy convenience command:
+docgenie-html README.md --source readme --output docs.html
+```
+
+#### Programmatic Usage (Python API)
+
+```python
+from docgenie.core import CodebaseAnalyzer
+from docgenie.html_generator import HTMLGenerator
+
+analyzer = CodebaseAnalyzer('/path/to/project')
+data = analyzer.analyze()
+
+html_generator = HTMLGenerator()
+html_content = html_generator.generate_from_analysis(data, "output.html")
+```
+
+## Troubleshooting
+
+- Ensure all dependencies are installed
+- Check write permissions for output directory
+- Use UTF-8 encoding for source files
+
+## License
+
+MIT License. See LICENSE file for details.
+
+## What DocGenie Analyzes
+
+- **Project Structure**: Directory tree and file organization
+- **Source Code**: Functions, classes, methods, and documentation
+- **Dependencies**: Package files (requirements.txt, package.json, etc.)
+- **Configuration**: Config files and project settings
+- **Documentation**: Existing docs and README files
+- **Git Information**: Repository details, branches, contributors
+- **Statistics**: Language distribution, code metrics
+
+## Example Output
+
+DocGenie generates README files with:
+
+- **Project Overview**: Auto-generated description and features
+- **Installation Instructions**: Detected from your dependency files
+- **Usage Examples**: Based on your code structure
+- **API Documentation**: Extracted from functions and classes
+- **Project Structure**: Visual directory tree
+- **Dependencies**: Organized by package manager
+- **Contributing Guidelines**: Standard open-source templates
+
+## Advanced Usage
+
+### Command Line Options
+
+```bash
+# Basic usage
+docgenie --help                                 # Show help
+docgenie generate . --verbose                   # Enable detailed output
+docgenie generate . --force                     # Overwrite existing files
+
+# Format options
+docgenie generate . --format markdown           # README.md only (default)
+docgenie generate . --format html               # HTML documentation only
+docgenie generate . --format both               # Generate both README.md and HTML
+
+# Output options
+docgenie generate . --output custom_path        # Custom output location
+docgenie generate . --preview                   # Preview without saving
+
+# HTML converter
+docgenie html README.md --source readme         # Convert README to HTML
+docgenie html . --source codebase               # Generate HTML from code
+
+# Analysis tools
+docgenie analyze . --format json                # Output analysis as JSON
+docgenie init                                   # Create basic README template
+```
+
+### Configuration
+
+Create a `.docgenie.yaml` file in your project root:
+
+```yaml
+ignore_patterns:
+  - "*.log"
+  - "temp/*"
+  - "private/"
+
+template_customizations:
+  include_api_docs: true
+  include_directory_tree: true
+  max_functions_documented: 20
+```
+
+## Architecture
+
+DocGenie consists of several key components:
+
+- **CodebaseAnalyzer**: Multi-language code analysis engine with caching and concurrency
+- **ParserRegistry**: Pluggable parsers (AST, tree-sitter, regex fallback) per language
+- **ReadmeGenerator**: Jinja2-based template rendering system for markdown
+- **HTMLGenerator**: Beautiful HTML documentation generator with responsive design
+- **CLI Interface**: Typer + Rich powered user experience
+
+## Contributing
+
+We welcome contributions! Here's how to get started:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes and add tests
+4. Run the test suite (`pytest`)
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+### Development Setup
+
+```bash
+git clone https://github.com/ch1kim0n1/DocGenie.git
+cd DocGenie
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Thanks to all contributors who help make DocGenie better
+- Inspired by the need for better automated documentation tools
+- Built with love for the open-source community
+
+---
+
+If DocGenie helps you, please star this repository.

docgenie_cli-1.1.0/pyproject.toml

@@ -0,0 +1,106 @@
+ [build-system]
+ requires = ["hatchling>=1.24"]
+ build-backend = "hatchling.build"
+
+ [project]
+ name = "docgenie-cli"
+ version = "1.1.0"
+ description = "Auto-documentation tool that generates comprehensive README and HTML docs for any codebase."
+ readme = "README.md"
+ license = { file = "LICENSE" }
+ authors = [
+   { name = "DocGenie Team", email = "contact@docgenie.dev" },
+ ]
+requires-python = ">=3.10"
+dependencies = [
+  "click>=8.1",
+  "typer>=0.12",
+  "rich>=13.7",
+  "structlog>=24.1",
+  "tree-sitter-language-pack>=0.13.0",
+  "gitpython>=3.1",
+  "jinja2>=3.1",
+  "pyyaml>=6.0",
+  "toml>=0.10",
+  "pygments>=2.10",
+  "pathspec>=0.9",
+  "requests>=2.25",
+  "markdown>=3.3",
+]
+ classifiers = [
+   "Development Status :: 4 - Beta",
+   "Intended Audience :: Developers",
+   "License :: OSI Approved :: MIT License",
+   "Operating System :: OS Independent",
+   "Programming Language :: Python",
+   "Programming Language :: Python :: 3",
+   "Programming Language :: Python :: 3.10",
+   "Programming Language :: Python :: 3.11",
+   "Programming Language :: Python :: 3.12",
+   "Programming Language :: Python :: 3.13",
+   "Topic :: Software Development :: Documentation",
+   "Topic :: Software Development :: Libraries :: Python Modules",
+ ]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=4.0",
+  "hypothesis>=6.0",
+  "ruff>=0.6",
+  "mypy>=1.10",
+  "types-PyYAML",
+  "types-toml",
+  "types-Markdown",
+  "bandit>=1.7",
+  "pre-commit>=3.6",
+  "mkdocs>=1.5",
+  "mkdocs-material>=9.5",
+  "mkdocstrings[python]>=0.24",
+]
+
+ [project.urls]
+ Homepage = "https://github.com/ch1kim0n1/DocGenie"
+ Repository = "https://github.com/ch1kim0n1/DocGenie"
+ Documentation = "https://github.com/ch1kim0n1/DocGenie"
+ Changelog = "https://github.com/ch1kim0n1/DocGenie/blob/main/CHANGELOG.md"
+
+[project.scripts]
+docgenie-cli = "docgenie.cli:app"
+docgenie-html = "docgenie.convert_to_html:main"
+
+ [tool.hatch.build]
+ include = ["src/docgenie", "README.md", "LICENSE"]
+ exclude = [".github", "examples", "docs"]
+
+ [tool.hatch.build.targets.wheel]
+ packages = ["src/docgenie"]
+
+ [tool.ruff]
+target-version = "py310"
+ line-length = 100
+ lint.select = ["E", "F", "I", "B", "UP", "S", "N", "A", "C4", "TID", "T20", "RET", "SIM", "PL"]
+ lint.ignore = ["B008"]
+lint.per-file-ignores = { "src/docgenie/cli.py" = ["PLR0913"], "src/docgenie/generator.py" = ["UP006", "UP035", "PLR0912", "E501", "PLR2004"], "src/docgenie/html_generator.py" = ["UP006", "UP035", "E501"], "src/docgenie/utils.py" = ["UP006", "UP035", "PLR0911", "PLR0912", "PLR2004"] }
+
+ [tool.mypy]
+python_version = "3.10"
+ warn_unused_configs = true
+ warn_unused_ignores = true
+ disallow_untyped_defs = true
+ disallow_incomplete_defs = true
+ check_untyped_defs = true
+ no_implicit_optional = true
+ strict_equality = true
+ pretty = true
+mypy_path = ["typings"]
+ exclude = ["examples", "docs"]
+
+ [tool.pytest.ini_options]
+addopts = "-ra -q --cov=docgenie --cov-report=term-missing"
+pythonpath = ["src"]
+
+[tool.bandit]
+targets = ["src"]
+exclude_dirs = ["tests", "examples"]
+skips = ["B101"]  # assert_used - we use asserts in tests

docgenie_cli-1.1.0/src/docgenie/__init__.py

@@ -0,0 +1,15 @@
+"""
+DocGenie - Auto-documentation tool for codebases
+
+A powerful Python library that automatically generates comprehensive README documentation
+for any codebase by analyzing source code, dependencies, and project structure.
+"""
+
+__version__ = "1.1.0"
+__author__ = "DocGenie Team"
+__email__ = "contact@docgenie.dev"
+
+from .core import CodebaseAnalyzer
+from .generator import ReadmeGenerator
+
+__all__ = ["CodebaseAnalyzer", "ReadmeGenerator"]