code2docs 0.1.1__tar.gz → 2.1.93__tar.gz

code2docs-2.1.93/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: code2docs
+Version: 2.1.93
+Summary: Auto-generate and sync project documentation from source code analysis
+Author-email: Tom Sapletta <tom@sapletta.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/wronai/code2docs
+Project-URL: Repository, https://github.com/wronai/code2docs
+Project-URL: Issues, https://github.com/wronai/code2docs/issues
+Keywords: documentation,auto-docs,readme-generator,api-reference,code-analysis,static-analysis,markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: code2llm>=0.5.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: click>=8.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == "watch"
+Provides-Extra: mkdocs
+Requires-Dist: mkdocs>=1.5; extra == "mkdocs"
+Requires-Dist: mkdocs-material>=9.0; extra == "mkdocs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# code2docs
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) for details.
+
+## Author
+
+Created by **Tom Sapletta** - [tom@sapletta.com](mailto:tom@sapletta.com)

code2docs-2.1.93/README.md

@@ -0,0 +1,9 @@
+# code2docs
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) for details.
+
+## Author
+
+Created by **Tom Sapletta** - [tom@sapletta.com](mailto:tom@sapletta.com)

{code2docs-0.1.1 → code2docs-2.1.93}/code2docs/__init__.py

@@ -5,7 +5,7 @@ Uses code2llm's AnalysisResult to produce human-readable documentation:
 README.md, API references, module docs, examples, and architecture diagrams.
 """
 
-__version__ = "0.1.1"
+__version__ = "2.1.93"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

code2docs-2.1.93/code2docs.egg-info/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: code2docs
+Version: 2.1.93
+Summary: Auto-generate and sync project documentation from source code analysis
+Author-email: Tom Sapletta <tom@sapletta.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/wronai/code2docs
+Project-URL: Repository, https://github.com/wronai/code2docs
+Project-URL: Issues, https://github.com/wronai/code2docs/issues
+Keywords: documentation,auto-docs,readme-generator,api-reference,code-analysis,static-analysis,markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: code2llm>=0.5.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: click>=8.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == "watch"
+Provides-Extra: mkdocs
+Requires-Dist: mkdocs>=1.5; extra == "mkdocs"
+Requires-Dist: mkdocs-material>=9.0; extra == "mkdocs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# code2docs
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) for details.
+
+## Author
+
+Created by **Tom Sapletta** - [tom@sapletta.com](mailto:tom@sapletta.com)

code2docs-2.1.93/code2docs.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+code2docs/__init__.py
+code2docs/__main__.py
+code2docs/cli.py
+code2docs/config.py
+code2docs.egg-info/PKG-INFO
+code2docs.egg-info/SOURCES.txt
+code2docs.egg-info/dependency_links.txt
+code2docs.egg-info/entry_points.txt
+code2docs.egg-info/requires.txt
+code2docs.egg-info/top_level.txt
+code2docs/analyzers/__init__.py
+code2docs/analyzers/dependency_scanner.py
+code2docs/analyzers/docstring_extractor.py
+code2docs/analyzers/endpoint_detector.py
+code2docs/analyzers/project_scanner.py
+code2docs/generators/__init__.py
+tests/test_code2docs.py

{code2docs-0.1.1 → code2docs-2.1.93}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "code2docs"
-version = "0.1.1"
+version = "2.1.93"
 description = "Auto-generate and sync project documentation from source code analysis"
 readme = "README.md"
 requires-python = ">=3.9"

code2docs-0.1.1/PKG-INFO

@@ -1,228 +0,0 @@
-Metadata-Version: 2.4
-Name: code2docs
-Version: 0.1.1
-Summary: Auto-generate and sync project documentation from source code analysis
-Author-email: Tom Sapletta <tom@sapletta.com>
-License-Expression: Apache-2.0
-Project-URL: Homepage, https://github.com/wronai/code2docs
-Project-URL: Repository, https://github.com/wronai/code2docs
-Project-URL: Issues, https://github.com/wronai/code2docs/issues
-Keywords: documentation,auto-docs,readme-generator,api-reference,code-analysis,static-analysis,markdown
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-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: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Software Development :: Code Generators
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: code2llm>=0.5.0
-Requires-Dist: jinja2>=3.1
-Requires-Dist: click>=8.0
-Requires-Dist: pyyaml>=6.0
-Provides-Extra: watch
-Requires-Dist: watchdog>=3.0; extra == "watch"
-Provides-Extra: mkdocs
-Requires-Dist: mkdocs>=1.5; extra == "mkdocs"
-Requires-Dist: mkdocs-material>=9.0; extra == "mkdocs"
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0; extra == "dev"
-Requires-Dist: black>=23.0; extra == "dev"
-Requires-Dist: ruff>=0.1; extra == "dev"
-Requires-Dist: mypy>=1.0; extra == "dev"
-Dynamic: license-file
-
-# code2docs
-
-![version](https://img.shields.io/badge/version-0.1.1-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
-
-> Auto-generate and sync project documentation from source code analysis.
-
-**code2docs** uses [code2llm](https://github.com/wronai/code2llm)'s `AnalysisResult` to produce human-readable documentation: README.md, API references, module docs, usage examples, and architecture diagrams.
-
-```
-code2llm  →  AnalysisResult  →  .toon / .mmd / context.md   (for LLM)
-code2docs →  AnalysisResult  →  README.md / docs/ / examples/  (for humans)
-```
-
-## Installation
-
-```bash
-pip install code2docs
-```
-
-Or from source:
-
-```bash
-git clone https://github.com/wronai/code2docs
-cd code2docs
-pip install -e .
-```
-
-### Optional extras
-
-```bash
-pip install code2docs[watch]    # file watcher (watchdog)
-pip install code2docs[mkdocs]   # MkDocs integration
-pip install code2docs[dev]      # development tools
-```
-
-## Quick Start
-
-```bash
-# Generate full documentation for a project
-code2docs ./my-project
-
-# Generate only README
-code2docs ./my-project --readme-only
-
-# Sync (regenerate only changed modules)
-code2docs sync ./my-project
-
-# Watch mode (auto-resync on file changes)
-code2docs watch ./my-project
-
-# Initialize config file
-code2docs init ./my-project
-
-# Dry-run (show what would be generated)
-code2docs ./my-project --dry-run
-```
-
-### Python API
-
-```python
-from code2docs import generate_readme, generate_docs, Code2DocsConfig
-
-# Generate README
-generate_readme("./my-project", output="README.md")
-
-# Generate full docs with custom config
-config = Code2DocsConfig(project_name="mylib", verbose=True)
-docs = generate_docs("./my-project", config=config)
-```
-
-## Generated Output
-
-```
-<project>/
-├── README.md                      # Main README (auto-generated sections)
-├── docs/
-│   ├── index.md                   # Documentation index
-│   ├── architecture.md            # Architecture + Mermaid diagrams
-│   ├── api/
-│   │   ├── index.md               # API overview
-│   │   ├── module_analyzer.md     # Per-module API reference
-│   │   └── ...
-│   └── modules/
-│       ├── analyzer.md            # Detailed module documentation
-│       └── ...
-├── examples/
-│   ├── basic_usage.py             # Auto-generated usage example
-│   ├── class_examples.py          # Class usage examples
-│   └── ...
-└── code2docs.yaml                 # Generator configuration
-```
-
-## Configuration
-
-Create `code2docs.yaml` in your project root (or run `code2docs init`):
-
-```yaml
-project:
-  name: my-project
-  source: ./
-  output: ./docs/
-
-readme:
-  sections:
-    - overview
-    - install
-    - quickstart
-    - api
-    - structure
-    - endpoints
-  badges:
-    - version
-    - python
-    - coverage
-    - complexity
-  sync_markers: true
-
-docs:
-  api_reference: true
-  module_docs: true
-  architecture: true
-  changelog: true
-
-examples:
-  auto_generate: true
-  from_entry_points: true
-
-sync:
-  strategy: markers    # markers | full | git-diff
-  watch: false
-  ignore:
-    - "tests/"
-    - "__pycache__"
-```
-
-## Sync Markers
-
-code2docs can update only specific sections of an existing README using markers:
-
-```markdown
-<!-- code2docs:start -->
-... auto-generated content ...
-<!-- code2docs:end -->
-```
-
-Content outside markers is preserved.
-
-## Architecture
-
-```
-code2docs/
-├── cli.py                    # CLI (click-based)
-├── config.py                 # Configuration (code2docs.yaml)
-├── analyzers/                # Adapters to code2llm + custom detectors
-│   ├── project_scanner.py    # Wrapper on code2llm.ProjectAnalyzer
-│   ├── endpoint_detector.py  # Flask/FastAPI/Django route extraction
-│   ├── docstring_extractor.py
-│   └── dependency_scanner.py
-├── generators/               # Documentation generators
-│   ├── readme_gen.py         # README.md generator
-│   ├── api_reference_gen.py  # docs/api/ reference from signatures
-│   ├── module_docs_gen.py    # docs/modules/ per-module docs
-│   ├── examples_gen.py       # examples/ from signatures
-│   ├── changelog_gen.py      # CHANGELOG from git log
-│   └── architecture_gen.py   # Architecture + Mermaid diagrams
-├── templates/                # Jinja2 templates
-├── sync/                     # Change detection & selective regeneration
-│   ├── differ.py
-│   ├── updater.py
-│   └── watcher.py
-└── formatters/               # Markdown, badges, TOC
-```
-
-## Requirements
-
-- Python >= 3.9
-- [code2llm](https://github.com/wronai/code2llm) >= 0.5.0
-- Jinja2 >= 3.1
-- Click >= 8.0
-- PyYAML >= 6.0
-
-## License
-
-Apache License 2.0 - see [LICENSE](LICENSE) for details.
-
-## Author
-
-Created by **Tom Sapletta** - [tom@sapletta.com](mailto:tom@sapletta.com)

code2docs-0.1.1/README.md

@@ -1,188 +0,0 @@
-# code2docs
-
-![version](https://img.shields.io/badge/version-0.1.1-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
-
-> Auto-generate and sync project documentation from source code analysis.
-
-**code2docs** uses [code2llm](https://github.com/wronai/code2llm)'s `AnalysisResult` to produce human-readable documentation: README.md, API references, module docs, usage examples, and architecture diagrams.
-
-```
-code2llm  →  AnalysisResult  →  .toon / .mmd / context.md   (for LLM)
-code2docs →  AnalysisResult  →  README.md / docs/ / examples/  (for humans)
-```
-
-## Installation
-
-```bash
-pip install code2docs
-```
-
-Or from source:
-
-```bash
-git clone https://github.com/wronai/code2docs
-cd code2docs
-pip install -e .
-```
-
-### Optional extras
-
-```bash
-pip install code2docs[watch]    # file watcher (watchdog)
-pip install code2docs[mkdocs]   # MkDocs integration
-pip install code2docs[dev]      # development tools
-```
-
-## Quick Start
-
-```bash
-# Generate full documentation for a project
-code2docs ./my-project
-
-# Generate only README
-code2docs ./my-project --readme-only
-
-# Sync (regenerate only changed modules)
-code2docs sync ./my-project
-
-# Watch mode (auto-resync on file changes)
-code2docs watch ./my-project
-
-# Initialize config file
-code2docs init ./my-project
-
-# Dry-run (show what would be generated)
-code2docs ./my-project --dry-run
-```
-
-### Python API
-
-```python
-from code2docs import generate_readme, generate_docs, Code2DocsConfig
-
-# Generate README
-generate_readme("./my-project", output="README.md")
-
-# Generate full docs with custom config
-config = Code2DocsConfig(project_name="mylib", verbose=True)
-docs = generate_docs("./my-project", config=config)
-```
-
-## Generated Output
-
-```
-<project>/
-├── README.md                      # Main README (auto-generated sections)
-├── docs/
-│   ├── index.md                   # Documentation index
-│   ├── architecture.md            # Architecture + Mermaid diagrams
-│   ├── api/
-│   │   ├── index.md               # API overview
-│   │   ├── module_analyzer.md     # Per-module API reference
-│   │   └── ...
-│   └── modules/
-│       ├── analyzer.md            # Detailed module documentation
-│       └── ...
-├── examples/
-│   ├── basic_usage.py             # Auto-generated usage example
-│   ├── class_examples.py          # Class usage examples
-│   └── ...
-└── code2docs.yaml                 # Generator configuration
-```
-
-## Configuration
-
-Create `code2docs.yaml` in your project root (or run `code2docs init`):
-
-```yaml
-project:
-  name: my-project
-  source: ./
-  output: ./docs/
-
-readme:
-  sections:
-    - overview
-    - install
-    - quickstart
-    - api
-    - structure
-    - endpoints
-  badges:
-    - version
-    - python
-    - coverage
-    - complexity
-  sync_markers: true
-
-docs:
-  api_reference: true
-  module_docs: true
-  architecture: true
-  changelog: true
-
-examples:
-  auto_generate: true
-  from_entry_points: true
-
-sync:
-  strategy: markers    # markers | full | git-diff
-  watch: false
-  ignore:
-    - "tests/"
-    - "__pycache__"
-```
-
-## Sync Markers
-
-code2docs can update only specific sections of an existing README using markers:
-
-```markdown
-<!-- code2docs:start -->
-... auto-generated content ...
-<!-- code2docs:end -->
-```
-
-Content outside markers is preserved.
-
-## Architecture
-
-```
-code2docs/
-├── cli.py                    # CLI (click-based)
-├── config.py                 # Configuration (code2docs.yaml)
-├── analyzers/                # Adapters to code2llm + custom detectors
-│   ├── project_scanner.py    # Wrapper on code2llm.ProjectAnalyzer
-│   ├── endpoint_detector.py  # Flask/FastAPI/Django route extraction
-│   ├── docstring_extractor.py
-│   └── dependency_scanner.py
-├── generators/               # Documentation generators
-│   ├── readme_gen.py         # README.md generator
-│   ├── api_reference_gen.py  # docs/api/ reference from signatures
-│   ├── module_docs_gen.py    # docs/modules/ per-module docs
-│   ├── examples_gen.py       # examples/ from signatures
-│   ├── changelog_gen.py      # CHANGELOG from git log
-│   └── architecture_gen.py   # Architecture + Mermaid diagrams
-├── templates/                # Jinja2 templates
-├── sync/                     # Change detection & selective regeneration
-│   ├── differ.py
-│   ├── updater.py
-│   └── watcher.py
-└── formatters/               # Markdown, badges, TOC
-```
-
-## Requirements
-
-- Python >= 3.9
-- [code2llm](https://github.com/wronai/code2llm) >= 0.5.0
-- Jinja2 >= 3.1
-- Click >= 8.0
-- PyYAML >= 6.0
-
-## License
-
-Apache License 2.0 - see [LICENSE](LICENSE) for details.
-
-## Author
-
-Created by **Tom Sapletta** - [tom@sapletta.com](mailto:tom@sapletta.com)

code2docs-0.1.1/code2docs/formatters/__init__.py

@@ -1,7 +0,0 @@
-"""Formatters — Markdown rendering, badges, TOC generation."""
-
-from .markdown import MarkdownFormatter
-from .badges import generate_badges
-from .toc import generate_toc
-
-__all__ = ["MarkdownFormatter", "generate_badges", "generate_toc"]

code2docs-0.1.1/code2docs/formatters/badges.py

@@ -1,52 +0,0 @@
-"""Badge generation using shields.io URLs."""
-
-from typing import Dict, List, Optional
-from urllib.parse import quote
-
-
-def generate_badges(project_name: str, badge_types: List[str],
-                    stats: Dict = None, deps=None) -> str:
-    """Generate shields.io badge Markdown strings."""
-    stats = stats or {}
-    badges: List[str] = []
-
-    for badge_type in badge_types:
-        badge = _make_badge(badge_type, project_name, stats, deps)
-        if badge:
-            badges.append(badge)
-
-    return " ".join(badges)
-
-
-def _make_badge(badge_type: str, project_name: str,
-                stats: Dict, deps) -> Optional[str]:
-    """Create a single badge Markdown string."""
-    name = quote(project_name)
-
-    if badge_type == "version":
-        return f"![version](https://img.shields.io/badge/version-0.1.0-blue)"
-
-    elif badge_type == "python":
-        py_version = ""
-        if deps and hasattr(deps, "python_version"):
-            py_version = deps.python_version
-        py_version = py_version or ">=3.9"
-        py_safe = quote(py_version)
-        return f"![python](https://img.shields.io/badge/python-{py_safe}-blue)"
-
-    elif badge_type == "coverage":
-        return f"![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey)"
-
-    elif badge_type == "complexity":
-        funcs = stats.get("functions_found", 0)
-        if funcs:
-            return f"![functions](https://img.shields.io/badge/functions-{funcs}-green)"
-        return None
-
-    elif badge_type == "license":
-        return f"![license](https://img.shields.io/badge/license-Apache%202.0-green)"
-
-    elif badge_type == "docs":
-        return f"![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)"
-
-    return None