code2docs 3.0.27__tar.gz → 3.0.29__tar.gz

{code2docs-3.0.27 → code2docs-3.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 3.0.27
+Version: 3.0.29
 Summary: Auto-generate and sync project documentation from source code analysis
 Author-email: Tom Sapletta <tom@sapletta.com>
 License-Expression: Apache-2.0
@@ -51,22 +51,19 @@ Provides-Extra: all
 Requires-Dist: code2docs[git,llm,mkdocs,watch]; extra == "all"
 Dynamic: license-file
 
-# code2docs
-
-
 ## AI Cost Tracking
 
-![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.27-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
-![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-18.6h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
+![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.29-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
+![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-23.8h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
 
-- 🤖 **LLM usage:** $7.5000 (59 commits)
-- 👤 **Human dev:** ~$1857 (18.6h @ $100/h, 30min dedup)
+- 🤖 **LLM usage:** $7.5000 (68 commits)
+- 👤 **Human dev:** ~$2384 (23.8h @ $100/h, 30min dedup)
 
-Generated on 2026-04-09 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
+Generated on 2026-04-19 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
 
 ---
 
-![version](https://img.shields.io/badge/version-3.0.27-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
+![version](https://img.shields.io/badge/version-3.0.29-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.
 
@@ -99,9 +96,6 @@ pip install code2docs[mkdocs]   # MkDocs integration
 pip install code2docs[dev]      # development tools
 ```
 
-## Quick Start
-
-```bash
 # Generate full documentation for a project
 code2docs ./my-project
 
@@ -206,7 +200,7 @@ code2docs can update only specific sections of an existing README using markers:
 ```markdown
 <!-- code2docs:start --># code2docs
 
-![version](https://img.shields.io/badge/version-3.0.27-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey) ![functions](https://img.shields.io/badge/functions-276-green)
+![version](https://img.shields.io/badge/version-3.0.29-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey) ![functions](https://img.shields.io/badge/functions-276-green)
 > **276** functions | **57** classes | **51** files | CC̄ = 3.8
 
 > Auto-generated project documentation from source code analysis.
@@ -215,8 +209,6 @@ code2docs can update only specific sections of an existing README using markers:
 **License:** Apache-2.0[(LICENSE)](./LICENSE)  
 **Repository:** [https://github.com/wronai/code2docs](https://github.com/wronai/code2docs)
 
-## Installation
-
 ### From PyPI
 
 ```bash
@@ -242,11 +234,6 @@ pip install code2docs[dev]    # development tools
 pip install code2docs[all]    # all optional features
 ```
 
-## Quick Start
-
-### CLI Usage
-
-```bash
 # Generate full documentation for your project
 code2docs ./my-project
 
@@ -299,47 +286,6 @@ When you run `code2docs`, the following files are produced:
 └── mkdocs.yml             # MkDocs site 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
-  badges:
-    - version
-    - python
-    - coverage
-  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 HTML comment markers:
@@ -359,8 +305,6 @@ Content outside the markers is preserved when regenerating. Enable this with `sy
 code2docs/
     ├── registry    ├── llm_helper├── code2docs/    ├── __main__    ├── 04_sync_and_watch    ├── 05_custom_generators    ├── quickstart    ├── 06_formatters    ├── advanced_usage    ├── 03_programmatic_api    ├── entry_points    ├── 07_web_frameworks    ├── class_examples    ├── basic_usage    ├── 01_cli_usage    ├── 02_configuration        ├── updater    ├── sync/        ├── watcher    ├── base        ├── quickstart        ├── advanced_usage        ├── markdown        ├── badges        ├── toc    ├── formatters/        ├── differ        ├── coverage_gen        ├── _source_links        ├── depgraph_gen        ├── getting_started_gen        ├── config_docs_gen        ├── changelog_gen    ├── generators/        ├── code2llm_gen        ├── module_docs_gen        ├── api_reference_gen        ├── examples_gen        ├── mkdocs_gen    ├── config        ├── api_changelog_gen        ├── _registry_adapters        ├── readme_gen        ├── contributing_gen    ├── analyzers/        ├── dependency_scanner        ├── endpoint_detector        ├── architecture_gen        ├── project_scanner        ├── docstring_extractor    ├── cli```
 
-## API Overview
-
 ### Classes
 
 - **`GeneratorRegistry`** — Registry of documentation generators.
@@ -535,9 +479,6 @@ code2docs/
 
 We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
 
-### Development Setup
-
-```bash
 # Clone the repository
 git clone https://github.com/wronai/code2docs
 cd code2docs
@@ -545,10 +486,6 @@ cd code2docs
 # Install in development mode
 pip install -e ".[dev]"
 
-# Run tests
-pytest
-```
-
 ## Documentation
 
 - 📖 [Full Documentation](https://github.com/wronai/code2docs/tree/main/docs) — API reference, module docs, architecture
@@ -585,167 +522,6 @@ Content outside the markers is preserved when regenerating. Enable this with `sy
 code2docs/
     ├── registry    ├── llm_helper├── code2docs/    ├── __main__    ├── 04_sync_and_watch    ├── 05_custom_generators    ├── 06_formatters    ├── 03_programmatic_api    ├── entry_points    ├── 07_web_frameworks    ├── class_examples    ├── basic_usage    ├── 01_cli_usage    ├── 02_configuration        ├── updater    ├── sync/        ├── watcher        ├── differ        ├── quickstart    ├── base        ├── advanced_usage        ├── badges        ├── markdown    ├── formatters/        ├── toc        ├── coverage_gen        ├── _source_links        ├── depgraph_gen        ├── getting_started_gen        ├── config_docs_gen        ├── changelog_gen    ├── generators/        ├── code2llm_gen        ├── module_docs_gen        ├── api_reference_gen        ├── examples_gen        ├── mkdocs_gen    ├── config        ├── api_changelog_gen        ├── _registry_adapters        ├── contributing_gen        ├── readme_gen    ├── analyzers/        ├── docstring_extractor        ├── endpoint_detector        ├── architecture_gen        ├── project_scanner    ├── cli        ├── dependency_scanner```
 
-## API Overview
-
-### Classes
-
-- **`GeneratorRegistry`** — Registry of documentation generators.
-- **`LLMHelper`** — Thin wrapper around litellm for documentation generation.
-- **`MetricsReportGenerator`** — Generate a metrics report from code analysis.
-- **`APIChangelogGenerator`** — Generate changelog based on API changes.
-- **`CustomGenerator`** — Example of extending the base generator class.
-- **`Updater`** — Apply selective documentation updates based on detected changes.
-- **`ChangeInfo`** — Describes a detected change.
-- **`Differ`** — Detect changes between current source and previous state.
-- **`GenerateContext`** — Shared context passed to all generators during a run.
-- **`BaseGenerator`** — Abstract base for all documentation generators.
-- **`MarkdownFormatter`** — Helper for constructing Markdown documents.
-- **`CoverageGenerator`** — Generate docs/coverage.md — docstring coverage report.
-- **`SourceLinker`** — Build source-code links (relative paths + optional GitHub/GitLab URLs).
-- **`DepGraphGenerator`** — Generate docs/dependency-graph.md with Mermaid diagrams.
-- **`GettingStartedGenerator`** — Generate docs/getting-started.md from entry points and dependencies.
-- **`ConfigDocsGenerator`** — Generate docs/configuration.md from Code2DocsConfig dataclass.
-- **`ChangelogEntry`** — A single changelog entry.
-- **`ChangelogGenerator`** — Generate CHANGELOG.md from git log and analysis diff.
-- **`Code2LlmGenerator`** — Generate code2llm analysis files in project/ directory.
-- **`ModuleDocsGenerator`** — Generate docs/modules.md — consolidated module documentation.
-- **`ApiReferenceGenerator`** — Generate docs/api.md — consolidated API reference.
-- **`ExamplesGenerator`** — Generate examples/ — usage examples from public API signatures.
-- **`MkDocsGenerator`** — Generate mkdocs.yml from the docs/ directory structure.
-- **`ReadmeConfig`** — Configuration for README generation.
-- **`DocsConfig`** — Configuration for docs/ generation.
-- **`ExamplesConfig`** — Configuration for examples/ generation.
-- **`SyncConfig`** — Configuration for synchronization.
-- **`Code2LlmConfig`** — Configuration for code2llm analysis generation.
-- **`LLMConfig`** — Configuration for optional LLM-assisted documentation generation.
-- **`Code2DocsConfig`** — Main configuration for code2docs.
-- **`ApiChange`** — A single API change between two analysis snapshots.
-- **`ApiChangelogGenerator`** — Generate API changelog by diffing current analysis with a saved snapshot.
-- **`ReadmeGeneratorAdapter`** — —
-- **`ApiReferenceAdapter`** — —
-- **`ModuleDocsAdapter`** — —
-- **`ArchitectureAdapter`** — —
-- **`DepGraphAdapter`** — —
-- **`CoverageAdapter`** — —
-- **`ApiChangelogAdapter`** — —
-- **`ExamplesAdapter`** — —
-- **`MkDocsAdapter`** — —
-- **`GettingStartedAdapter`** — —
-- **`ConfigDocsAdapter`** — —
-- **`ContributingAdapter`** — —
-- **`Code2LlmAdapter`** — Adapter for code2llm analysis generation.
-- **`ContributingGenerator`** — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
-- **`ReadmeGenerator`** — Generate README.md from AnalysisResult.
-- **`DocstringInfo`** — Parsed docstring with sections.
-- **`DocstringExtractor`** — Extract and parse docstrings from AnalysisResult.
-- **`Endpoint`** — Represents a detected web endpoint.
-- **`EndpointDetector`** — Detects web endpoints from decorator patterns in source code.
-- **`ArchitectureGenerator`** — Generate docs/architecture.md — architecture overview with diagrams.
-- **`ProjectScanner`** — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
-- **`DefaultGroup`** — Click Group that routes unknown subcommands to 'generate'.
-- **`DependencyInfo`** — Information about a project dependency.
-- **`ProjectDependencies`** — All detected project dependencies.
-- **`DependencyScanner`** — Scan and parse project dependency files.
-
-### Functions
-
-- `detect_changes_example(project_path)` — Detect what files have changed since last documentation generation.
-- `update_docs_incrementally(project_path)` — Update only the parts of docs that need changing.
-- `force_full_regeneration(project_path)` — Force full regeneration of all documentation.
-- `watch_and_auto_regenerate(project_path, interval)` — Watch for file changes and auto-regenerate documentation.
-- `custom_watcher_with_hooks(project_path)` — Set up a custom watcher with pre/post generation hooks.
-- `sync_with_git_changes(project_path)` — Only regenerate docs for files changed in git.
-- `generate_custom_report(project_path)` — Generate a custom metrics report.
-- `markdown_formatting_examples()` — Demonstrate markdown formatting utilities.
-- `generate_complex_document()` — Generate a complex markdown document using the formatter.
-- `badge_examples()` — Generate various badge examples.
-- `toc_examples()` — Demonstrate table of contents generation.
-- `build_custom_readme()` — Build a custom README using formatters.
-- `generate_readme_simple(project_path)` — Generate README.md content from a project.
-- `generate_full_documentation(project_path)` — Generate complete documentation for a project.
-- `custom_documentation_pipeline(project_path)` — Create a custom documentation pipeline.
-- `inspect_project_structure(project_path)` — Inspect project structure from analysis.
-- `generate_docs_if_needed(project_path, force)` — Only generate docs if code has changed.
-- `detect_flask_endpoints(project_path)` — Detect Flask endpoints in a project.
-- `detect_fastapi_endpoints(project_path)` — Detect FastAPI endpoints in a project.
-- `generate_api_docs_from_endpoints(project_path, output_dir)` — Generate API documentation from detected endpoints.
-- `create_example_web_apps(target_dir)` — Create example Flask and FastAPI apps for testing.
-- `document_web_project(project_path)` — Complete workflow: detect endpoints and generate docs.
-- `run_cli_basic(project_path)` — Run code2docs CLI programmatically.
-- `run_cli_with_config(project_path, config_path)` — Run with custom configuration.
-- `create_basic_config()` — Create a basic configuration.
-- `create_advanced_config()` — Create advanced configuration with all options.
-- `save_yaml_config_example(path)` — Save example YAML config to file.
-- `load_config_from_yaml(path)` — Load configuration from YAML file.
-- `start_watcher(project_path, config)` — Start watching project for file changes and auto-resync docs.
-- `generate_badges(project_name, badge_types, stats, deps)` — Generate shields.io badge Markdown strings.
-- `generate_toc(markdown_content, max_depth)` — Generate a table of contents from Markdown headings.
-- `extract_headings(content, max_depth)` — Extract headings from Markdown content.
-- `generate_docs(project_path, config)` — High-level function to generate all documentation.
-- `generate_code2llm_analysis(project_path, config)` — Convenience function to generate code2llm analysis.
-- `generate_readme(project_path, output, sections, sync_markers)` — Convenience function to generate a README.
-- `analyze_and_document(project_path, config)` — Convenience function: analyze a project in one call.
-- `main()` — code2docs — Auto-generate project documentation from source code.
-- `generate(project_path, config_path, readme_only, sections)` — Generate documentation (default command).
-- `sync(project_path, config_path, verbose, dry_run)` — Synchronize documentation with source code changes.
-- `watch(project_path, config_path, verbose)` — Watch for file changes and auto-regenerate docs.
-- `init(project_path, output)` — Initialize code2docs.yaml configuration file.
-- `check(project_path, config_path, target)` — Health check — verify documentation completeness.
-- `diff(project_path, config_path)` — Preview what would change without writing anything.
-
-
-## Project Structure
-
-📦 `code2docs` (1 functions)
-📄 `code2docs.__main__`
-📦 `code2docs.analyzers`
-📄 `code2docs.analyzers.dependency_scanner` (6 functions, 3 classes)
-📄 `code2docs.analyzers.docstring_extractor` (10 functions, 2 classes)
-📄 `code2docs.analyzers.endpoint_detector` (3 functions, 2 classes)
-📄 `code2docs.analyzers.project_scanner` (4 functions, 1 classes)
-📄 `code2docs.base` (3 functions, 2 classes)
-📄 `code2docs.cli` (14 functions, 1 classes)
-📄 `code2docs.config` (5 functions, 7 classes)
-📄 `code2docs.examples.advanced_usage`
-📄 `code2docs.examples.quickstart`
-📦 `code2docs.formatters`
-📄 `code2docs.formatters.badges` (2 functions)
-📄 `code2docs.formatters.markdown` (13 functions, 1 classes)
-📄 `code2docs.formatters.toc` (3 functions)
-📦 `code2docs.generators` (1 functions)
-📄 `code2docs.generators._registry_adapters` (26 functions, 13 classes)
-📄 `code2docs.generators._source_links` (6 functions, 1 classes)
-📄 `code2docs.generators.api_changelog_gen` (9 functions, 2 classes)
-📄 `code2docs.generators.api_reference_gen` (7 functions, 1 classes)
-📄 `code2docs.generators.architecture_gen` (10 functions, 1 classes)
-📄 `code2docs.generators.changelog_gen` (6 functions, 2 classes)
-📄 `code2docs.generators.code2llm_gen` (5 functions, 1 classes)
-📄 `code2docs.generators.config_docs_gen` (4 functions, 1 classes)
-📄 `code2docs.generators.contributing_gen` (8 functions, 1 classes)
-📄 `code2docs.generators.coverage_gen` (7 functions, 1 classes)
-📄 `code2docs.generators.depgraph_gen` (9 functions, 1 classes)
-📄 `code2docs.generators.examples_gen` (14 functions, 1 classes)
-📄 `code2docs.generators.getting_started_gen` (8 functions, 1 classes)
-📄 `code2docs.generators.mkdocs_gen` (4 functions, 1 classes)
-📄 `code2docs.generators.module_docs_gen` (9 functions, 1 classes)
-📄 `code2docs.generators.readme_gen` (18 functions, 1 classes)
-📄 `code2docs.llm_helper` (7 functions, 1 classes)
-📄 `code2docs.registry` (4 functions, 1 classes)
-📦 `code2docs.sync`
-📄 `code2docs.sync.differ` (7 functions, 2 classes)
-📄 `code2docs.sync.updater` (2 functions, 1 classes)
-📄 `code2docs.sync.watcher` (1 functions)
-📄 `examples.01_cli_usage` (2 functions)
-📄 `examples.02_configuration` (4 functions)
-📄 `examples.03_programmatic_api` (5 functions)
-📄 `examples.04_sync_and_watch` (6 functions)
-📄 `examples.05_custom_generators` (13 functions, 3 classes)
-📄 `examples.06_formatters` (5 functions)
-📄 `examples.07_web_frameworks` (5 functions)
-📄 `examples.basic_usage`
-📄 `examples.class_examples`
-📄 `examples.entry_points`
-
 ## Requirements
 
 - Python >= >=3.9
@@ -759,9 +535,6 @@ code2docs/
 
 We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
 
-### Development Setup
-
-```bash
 # Clone the repository
 git clone https://github.com/wronai/code2docs
 cd code2docs
@@ -769,40 +542,6 @@ cd code2docs
 # Install in development mode
 pip install -e ".[dev]"
 
-# Run tests
-pytest
-```
-
-## Documentation
-
-- 📖 [Full Documentation](https://github.com/wronai/code2docs/tree/main/docs) — API reference, module docs, architecture
-- 🚀 [Getting Started](https://github.com/wronai/code2docs/blob/main/docs/getting-started.md) — Quick start guide
-- 📚 [API Reference](https://github.com/wronai/code2docs/blob/main/docs/api.md) — Complete API documentation
-- 🔧 [Configuration](https://github.com/wronai/code2docs/blob/main/docs/configuration.md) — Configuration options
-- 💡 [Examples](./examples) — Usage examples and code samples
-
-### Generated Files
-
-| Output | Description | Link |
-|--------|-------------|------|
-| `README.md` | Project overview (this file) | — |
-| `docs/api.md` | Consolidated API reference | [View](./docs/api.md) |
-| `docs/modules.md` | Module reference with metrics | [View](./docs/modules.md) |
-| `docs/architecture.md` | Architecture with diagrams | [View](./docs/architecture.md) |
-| `docs/dependency-graph.md` | Dependency graphs | [View](./docs/dependency-graph.md) |
-| `docs/coverage.md` | Docstring coverage report | [View](./docs/coverage.md) |
-| `docs/getting-started.md` | Getting started guide | [View](./docs/getting-started.md) |
-| `docs/configuration.md` | Configuration reference | [View](./docs/configuration.md) |
-| `docs/api-changelog.md` | API change tracking | [View](./docs/api-changelog.md) |
-| `CONTRIBUTING.md` | Contribution guidelines | [View](./CONTRIBUTING.md) |
-| `examples/` | Usage examples | [Browse](./examples) |
-| `mkdocs.yml` | MkDocs configuration | — |
-
-<!-- code2docs:end -->
-```
-
-Content outside markers is preserved.
-
 ## Architecture
 
 ```
@@ -840,6 +579,3 @@ code2docs/
 ## License
 
 Licensed under Apache-2.0.
-## Author
-
-Tom Sapletta