code2docs 3.0.31__tar.gz → 3.0.33__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. {code2docs-3.0.31 → code2docs-3.0.33}/PKG-INFO +5 -5
  2. {code2docs-3.0.31 → code2docs-3.0.33}/README.md +4 -4
  3. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/__init__.py +1 -1
  4. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/examples_gen.py +6 -34
  5. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/PKG-INFO +5 -5
  6. {code2docs-3.0.31 → code2docs-3.0.33}/pyproject.toml +1 -1
  7. {code2docs-3.0.31 → code2docs-3.0.33}/LICENSE +0 -0
  8. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/__main__.py +0 -0
  9. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/__init__.py +0 -0
  10. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/dependency_scanner.py +0 -0
  11. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/docstring_extractor.py +0 -0
  12. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/endpoint_detector.py +0 -0
  13. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/markdown_validator.py +0 -0
  14. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/analyzers/project_scanner.py +0 -0
  15. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/base.py +0 -0
  16. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/cli.py +0 -0
  17. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/config.py +0 -0
  18. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/examples/advanced_usage.py +0 -0
  19. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/examples/quickstart.py +0 -0
  20. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/formatters/__init__.py +0 -0
  21. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/formatters/badges.py +0 -0
  22. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/formatters/markdown.py +0 -0
  23. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/formatters/toc.py +0 -0
  24. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/__init__.py +0 -0
  25. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/_registry_adapters.py +0 -0
  26. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/_source_links.py +0 -0
  27. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/api_changelog_gen.py +0 -0
  28. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/api_reference_gen.py +0 -0
  29. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/architecture_gen.py +0 -0
  30. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/changelog_gen.py +0 -0
  31. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/code2llm_gen.py +0 -0
  32. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/config_docs_gen.py +0 -0
  33. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/contributing_gen.py +0 -0
  34. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/coverage_gen.py +0 -0
  35. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/depgraph_gen.py +0 -0
  36. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/getting_started_gen.py +0 -0
  37. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/mkdocs_gen.py +0 -0
  38. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/module_docs_gen.py +0 -0
  39. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/org_readme_gen.py +0 -0
  40. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/readme_gen.py +0 -0
  41. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/llm_helper.py +0 -0
  42. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/registry.py +0 -0
  43. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/sync/__init__.py +0 -0
  44. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/sync/differ.py +0 -0
  45. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/sync/updater.py +0 -0
  46. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/sync/watcher.py +0 -0
  47. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/api_module.md.j2 +0 -0
  48. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/architecture.md.j2 +0 -0
  49. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/example_usage.py.j2 +0 -0
  50. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/index.md.j2 +0 -0
  51. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/module_doc.md.j2 +0 -0
  52. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs/templates/readme.md.j2 +0 -0
  53. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/SOURCES.txt +0 -0
  54. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/dependency_links.txt +0 -0
  55. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/entry_points.txt +0 -0
  56. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/requires.txt +0 -0
  57. {code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/top_level.txt +0 -0
  58. {code2docs-3.0.31 → code2docs-3.0.33}/setup.cfg +0 -0
  59. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_analyzers.py +0 -0
  60. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_cli.py +0 -0
  61. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_code2docs.py +0 -0
  62. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_config.py +0 -0
  63. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_formatters.py +0 -0
  64. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_generators.py +0 -0
  65. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_llm_helper.py +0 -0
  66. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_markdown_validator.py +0 -0
  67. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_registry.py +0 -0
  68. {code2docs-3.0.31 → code2docs-3.0.33}/tests/test_sync.py +0 -0
{code2docs-3.0.31 → code2docs-3.0.33}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: code2docs
3
- Version: 3.0.31
3
+ Version: 3.0.33
4
4
  Summary: Auto-generate and sync project documentation from source code analysis
5
5
  Author-email: Tom Sapletta <tom@sapletta.com>
6
6
  License-Expression: Apache-2.0
@@ -53,17 +53,17 @@ Dynamic: license-file
53
53
 
54
54
  ## AI Cost Tracking
55
55
 
56
- ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.31-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
56
+ ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.33-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
57
57
  ![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-25.3h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
58
58
 
59
- - 🤖 **LLM usage:** $7.5000 (71 commits)
59
+ - 🤖 **LLM usage:** $7.5000 (73 commits)
60
60
  - 👤 **Human dev:** ~$2534 (25.3h @ $100/h, 30min dedup)
61
61
 
62
62
  Generated on 2026-04-20 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
63
63
 
64
64
  ---
65
65
 
66
- ![version](https://img.shields.io/badge/version-3.0.31-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
66
+ ![version](https://img.shields.io/badge/version-3.0.33-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
67
67
 
68
68
  > Auto-generate and sync project documentation from source code analysis.
69
69
 
@@ -200,7 +200,7 @@ code2docs can update only specific sections of an existing README using markers:
200
200
  ```markdown
201
201
  <!-- code2docs:start --># code2docs
202
202
 
203
- ![version](https://img.shields.io/badge/version-3.0.31-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)
203
+ ![version](https://img.shields.io/badge/version-3.0.33-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)
204
204
  > **276** functions | **57** classes | **51** files | CC̄ = 3.8
205
205
 
206
206
  > Auto-generated project documentation from source code analysis.
{code2docs-3.0.31 → code2docs-3.0.33}/README.md RENAMED
@@ -1,16 +1,16 @@
1
1
  ## AI Cost Tracking
2
2
 
3
- ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.31-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
3
+ ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.33-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
4
4
  ![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-25.3h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
5
5
 
6
- - 🤖 **LLM usage:** $7.5000 (71 commits)
6
+ - 🤖 **LLM usage:** $7.5000 (73 commits)
7
7
  - 👤 **Human dev:** ~$2534 (25.3h @ $100/h, 30min dedup)
8
8
 
9
9
  Generated on 2026-04-20 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
10
10
 
11
11
  ---
12
12
 
13
- ![version](https://img.shields.io/badge/version-3.0.31-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
13
+ ![version](https://img.shields.io/badge/version-3.0.33-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
14
14
 
15
15
  > Auto-generate and sync project documentation from source code analysis.
16
16
 
@@ -147,7 +147,7 @@ code2docs can update only specific sections of an existing README using markers:
147
147
  ```markdown
148
148
  <!-- code2docs:start --># code2docs
149
149
 
150
- ![version](https://img.shields.io/badge/version-3.0.31-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)
150
+ ![version](https://img.shields.io/badge/version-3.0.33-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)
151
151
  > **276** functions | **57** classes | **51** files | CC̄ = 3.8
152
152
 
153
153
  > Auto-generated project documentation from source code analysis.
{code2docs-3.0.31 → code2docs-3.0.33}/code2docs/__init__.py RENAMED
@@ -5,7 +5,7 @@ Uses code2llm's AnalysisResult to produce human-readable documentation:
5
5
  README.md, API references, module docs, examples, and architecture diagrams.
6
6
  """
7
7
 
8
- __version__ = '3.0.31'
8
+ __version__ = '3.0.33'
9
9
  __author__ = 'Tom Sapletta'
10
10
  __all__ = ['Code2DocsConfig', 'generate_readme', 'generate_docs', 'analyze_and_document']
11
11
 
{code2docs-3.0.31 → code2docs-3.0.33}/code2docs/generators/examples_gen.py RENAMED
@@ -1,33 +1,3 @@
1
-
2
- PORT_4 = 4
3
- CONSTANT_5 = 5
4
- CONSTANT_50 = 50
5
-
6
-
7
- PORT_4 = PORT_4
8
- CONSTANT_5 = CONSTANT_5
9
- CONSTANT_50 = CONSTANT_50
10
-
11
-
12
- PORT_4 = PORT_4
13
- CONSTANT_5 = CONSTANT_5
14
- CONSTANT_50 = CONSTANT_50
15
-
16
-
17
- PORT_4 = PORT_4
18
- CONSTANT_5 = CONSTANT_5
19
- CONSTANT_50 = CONSTANT_50
20
-
21
-
22
-
23
- PORT_4 = PORT_4
24
- CONSTANT_5 = CONSTANT_5
25
- CONSTANT_50 = CONSTANT_50
26
-
27
- PORT_4 = PORT_4
28
- CONSTANT_5 = CONSTANT_5
29
- CONSTANT_50 = CONSTANT_50
30
-
31
1
  """Auto-generate usage examples from public signatures and entry points."""
32
2
 
33
3
  from pathlib import Path
@@ -37,10 +7,12 @@ from code2llm.api import AnalysisResult, FunctionInfo, ClassInfo
37
7
 
38
8
  from ..config import Code2DocsConfig
39
9
 
40
- # Default type hints → example values
10
+ PORT_4 = 4
11
+ CONSTANT_5 = 5
12
+ CONSTANT_50 = 50
41
13
 
42
- if __name__ == "__main__":
43
- _TYPE_EXAMPLES = {
14
+ # Default type hints → example values
15
+ _TYPE_EXAMPLES = {
44
16
  "str": '"./my-project"',
45
17
  "Path": 'Path("./my-project")',
46
18
  "int": "10",
@@ -55,7 +27,7 @@ if __name__ == "__main__":
55
27
  }
56
28
 
57
29
  # Arg name → realistic example value
58
- _ARG_EXAMPLES = {
30
+ _ARG_EXAMPLES = {
59
31
  "project_path": '"./my-project"',
60
32
  "path": '"./my-project"',
61
33
  "source": '"./src"',
{code2docs-3.0.31 → code2docs-3.0.33}/code2docs.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: code2docs
3
- Version: 3.0.31
3
+ Version: 3.0.33
4
4
  Summary: Auto-generate and sync project documentation from source code analysis
5
5
  Author-email: Tom Sapletta <tom@sapletta.com>
6
6
  License-Expression: Apache-2.0
@@ -53,17 +53,17 @@ Dynamic: license-file
53
53
 
54
54
  ## AI Cost Tracking
55
55
 
56
- ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.31-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
56
+ ![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.33-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
57
57
  ![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-25.3h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
58
58
 
59
- - 🤖 **LLM usage:** $7.5000 (71 commits)
59
+ - 🤖 **LLM usage:** $7.5000 (73 commits)
60
60
  - 👤 **Human dev:** ~$2534 (25.3h @ $100/h, 30min dedup)
61
61
 
62
62
  Generated on 2026-04-20 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
63
63
 
64
64
  ---
65
65
 
66
- ![version](https://img.shields.io/badge/version-3.0.31-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
66
+ ![version](https://img.shields.io/badge/version-3.0.33-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
67
67
 
68
68
  > Auto-generate and sync project documentation from source code analysis.
69
69
 
@@ -200,7 +200,7 @@ code2docs can update only specific sections of an existing README using markers:
200
200
  ```markdown
201
201
  <!-- code2docs:start --># code2docs
202
202
 
203
- ![version](https://img.shields.io/badge/version-3.0.31-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)
203
+ ![version](https://img.shields.io/badge/version-3.0.33-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)
204
204
  > **276** functions | **57** classes | **51** files | CC̄ = 3.8
205
205
 
206
206
  > Auto-generated project documentation from source code analysis.
{code2docs-3.0.31 → code2docs-3.0.33}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "code2docs"
7
- version = "3.0.31"
7
+ version = "3.0.33"
8
8
  description = "Auto-generate and sync project documentation from source code analysis"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
{code2docs-3.0.31 → code2docs-3.0.33}/LICENSE RENAMED
File without changes
{code2docs-3.0.31 → code2docs-3.0.33}/code2docs/base.py RENAMED
File without changes
{code2docs-3.0.31 → code2docs-3.0.33}/code2docs/cli.py RENAMED
File without changes
{code2docs-3.0.31 → code2docs-3.0.33}/setup.cfg RENAMED
File without changes
{code2docs-3.0.31 → code2docs-3.0.33}/tests/test_cli.py RENAMED
File without changes