cod8a 0.2.0__tar.gz → 0.2.2__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.
- {cod8a-0.2.0 → cod8a-0.2.2}/PKG-INFO +4 -5
- {cod8a-0.2.0 → cod8a-0.2.2}/README.md +3 -3
- {cod8a-0.2.0 → cod8a-0.2.2}/pyproject.toml +1 -2
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/cli.py +11 -11
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/helpers/cli_helper.py +1 -1
- {cod8a-0.2.0 → cod8a-0.2.2}/LICENSE +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/__init__.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/cod8a.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/CodeAnalyzer.csproj +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/CodeAnalyzer.csproj.lscache +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/Parsers/BaseParser.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/Parsers/FileParser.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/Parsers/ProjectParser.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/Parsers/SolutionParser.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/Program.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/models/FileStructure.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/models/ProjectStructure.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/CodeAnalyzer/models/SolutionStructure.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/Test/CodeAnalyzerTest.csproj +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/Test/ExtensionTypeTest.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/dotnet/Test/Mermaid/ClassDiagramTest.cs +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/enums/__init__.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/enums/diagram_type.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/generators/mermaid/class_diagram.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/generators/mermaid/flowchart_diagram.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/generators/mermaid/sequence_diagram.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/helpers/__init__.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/models/__init__.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/models/models.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/parsers/dotnet_parser.py +0 -0
- {cod8a-0.2.0 → cod8a-0.2.2}/src/cod8a/parsers/python_parser.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: cod8a
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.2
|
|
4
4
|
Summary: cod8a is a code documentation and visualization tool for Python and .NET projects
|
|
5
5
|
License-Expression: MIT
|
|
6
6
|
License-File: LICENSE
|
|
@@ -14,7 +14,6 @@ Classifier: Programming Language :: Python :: 3.13
|
|
|
14
14
|
Classifier: Programming Language :: Python :: 3.14
|
|
15
15
|
Requires-Dist: click (>=8.3.3,<9.0.0)
|
|
16
16
|
Requires-Dist: pydantic (>=2.13.3,<3.0.0)
|
|
17
|
-
Project-URL: Homepage, https://github.com/marietta-a/cod8a
|
|
18
17
|
Project-URL: Repository, https://github.com/marietta-a/cod8a
|
|
19
18
|
Description-Content-Type: text/markdown
|
|
20
19
|
|
|
@@ -73,9 +72,9 @@ cod8a uml -p <path_to_source> --no-summarize
|
|
|
73
72
|
### Samples
|
|
74
73
|
Below are detailed example Mermaid diagrams generated by `cod8a` based on its own `src/cod8a/models/models.py` file:
|
|
75
74
|
|
|
76
|
-
- [Class Diagram Example](examples/class_diagram.mmd)
|
|
77
|
-
- [Flowchart Example](examples/flowchart.mmd)
|
|
78
|
-
- [Sequence Diagram Example](examples/sequence_diagram.mmd)
|
|
75
|
+
- [Class Diagram Example](https://github.com/marietta-a/cod8a/blob/main/examples/class_diagram.mmd)
|
|
76
|
+
- [Flowchart Example](https://github.com/marietta-a/cod8a/blob/main/examples/flowchart.mmd)
|
|
77
|
+
- [Sequence Diagram Example](https://github.com/marietta-a/cod8a/blob/main/examples/sequence_diagram.mmd)
|
|
79
78
|
|
|
80
79
|
### CLI Options
|
|
81
80
|
|
|
@@ -53,9 +53,9 @@ cod8a uml -p <path_to_source> --no-summarize
|
|
|
53
53
|
### Samples
|
|
54
54
|
Below are detailed example Mermaid diagrams generated by `cod8a` based on its own `src/cod8a/models/models.py` file:
|
|
55
55
|
|
|
56
|
-
- [Class Diagram Example](examples/class_diagram.mmd)
|
|
57
|
-
- [Flowchart Example](examples/flowchart.mmd)
|
|
58
|
-
- [Sequence Diagram Example](examples/sequence_diagram.mmd)
|
|
56
|
+
- [Class Diagram Example](https://github.com/marietta-a/cod8a/blob/main/examples/class_diagram.mmd)
|
|
57
|
+
- [Flowchart Example](https://github.com/marietta-a/cod8a/blob/main/examples/flowchart.mmd)
|
|
58
|
+
- [Sequence Diagram Example](https://github.com/marietta-a/cod8a/blob/main/examples/sequence_diagram.mmd)
|
|
59
59
|
|
|
60
60
|
### CLI Options
|
|
61
61
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "cod8a"
|
|
3
|
-
version = "0.2.
|
|
3
|
+
version = "0.2.2"
|
|
4
4
|
description = "cod8a is a code documentation and visualization tool for Python and .NET projects"
|
|
5
5
|
authors = [
|
|
6
6
|
{ name = "Marietta Akumbom",email = "akumbom5ma@gmail.com"}
|
|
@@ -18,7 +18,6 @@ dependencies = [
|
|
|
18
18
|
]
|
|
19
19
|
|
|
20
20
|
[project.urls]
|
|
21
|
-
Homepage = "https://github.com/marietta-a/cod8a"
|
|
22
21
|
Repository = "https://github.com/marietta-a/cod8a"
|
|
23
22
|
|
|
24
23
|
[tool.poetry]
|
|
@@ -87,24 +87,24 @@ def uml(path, diagram_type, output, summarize):
|
|
|
87
87
|
save_diagram(struct, canon_type, diagram, output, path)
|
|
88
88
|
|
|
89
89
|
|
|
90
|
-
# TODO Generating code documentation
|
|
91
|
-
@click.command(help="[TODO] Generate documentation (Markdown format) from code structure.")
|
|
92
|
-
@click.option('-p', '--path', help='Specific path of file(s) to analyze')
|
|
93
|
-
@click.option('--json', 'output_json', is_flag=True, help='Output in JSON format')
|
|
94
|
-
def doc_cli(path, output_json):
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
90
|
+
# # TODO Generating code documentation
|
|
91
|
+
# @click.command(help="[TODO] Generate documentation (Markdown format) from code structure.")
|
|
92
|
+
# @click.option('-p', '--path', help='Specific path of file(s) to analyze')
|
|
93
|
+
# @click.option('--json', 'output_json', is_flag=True, help='Output in JSON format')
|
|
94
|
+
# def doc_cli(path, output_json):
|
|
95
|
+
# """Generate documentation (Markdown format)."""
|
|
96
|
+
# target = path or os.getcwd()
|
|
97
|
+
# struct = extract_structure(target)
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
# Main entry point for cod8a
|
|
101
101
|
def main():
|
|
102
|
-
cli.add_command(doc_cli, name="doc")
|
|
102
|
+
# cli.add_command(doc_cli, name="doc")
|
|
103
103
|
cli()
|
|
104
104
|
|
|
105
105
|
# Separate entry point for code8a
|
|
106
|
-
def doc_main():
|
|
107
|
-
doc_cli()
|
|
106
|
+
# def doc_main():
|
|
107
|
+
# doc_cli()
|
|
108
108
|
|
|
109
109
|
if __name__ == "__main__":
|
|
110
110
|
main()
|
|
@@ -25,7 +25,7 @@ def extract_structure(path) -> Union[FileStructure | ProjectStructure | list[Fil
|
|
|
25
25
|
|
|
26
26
|
pathExists = os.path.exists(path)
|
|
27
27
|
if not pathExists:
|
|
28
|
-
print("Not found")
|
|
28
|
+
print("Not found: Ensure path doesn't end with a separator and points to a valid file or directory.")
|
|
29
29
|
return
|
|
30
30
|
|
|
31
31
|
struct = parser.parse(path or os.getcwd())
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|