docwright 0.1.0__tar.gz → 0.1.1__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.
- {docwright-0.1.0 → docwright-0.1.1}/PKG-INFO +21 -21
- {docwright-0.1.0 → docwright-0.1.1}/README.md +18 -18
- {docwright-0.1.0 → docwright-0.1.1}/pyproject.toml +4 -4
- {docwright-0.1.0 → docwright-0.1.1}/LICENSE +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/analyzer.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/readme/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/readme/default.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/adr.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/api-contracts.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/architecture.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/data-model.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/db-schema.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/development-guide.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/integrations.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/operations.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/security.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/troubleshooting.md.j2 +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/cli.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/config.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/engine.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/outputs/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/outputs/base.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/outputs/direct.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/outputs/factory.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/outputs/pull_request.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/base.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/claude.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/factory.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/ollama.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/providers/openai.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/registry.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/renderer.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/reporters/__init__.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/reporters/html.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/reporters/terminal.py +0 -0
- {docwright-0.1.0 → docwright-0.1.1}/ai_docgen/scaffolder.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: docwright
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.1
|
|
4
4
|
Summary: AI-powered documentation agent: auto-generates and maintains README & wiki on every commit
|
|
5
5
|
License: MIT
|
|
6
6
|
License-File: LICENSE
|
|
@@ -29,11 +29,11 @@ Requires-Dist: openai (>=1.30,<2.0)
|
|
|
29
29
|
Requires-Dist: pydantic (>=2.0,<3.0)
|
|
30
30
|
Requires-Dist: pyyaml (>=6.0,<7.0)
|
|
31
31
|
Requires-Dist: rich (>=13.0,<14.0)
|
|
32
|
-
Project-URL: Homepage, https://github.com/GotlibArtem/
|
|
33
|
-
Project-URL: Repository, https://github.com/GotlibArtem/
|
|
32
|
+
Project-URL: Homepage, https://github.com/GotlibArtem/docwright
|
|
33
|
+
Project-URL: Repository, https://github.com/GotlibArtem/docwright
|
|
34
34
|
Description-Content-Type: text/markdown
|
|
35
35
|
|
|
36
|
-
#
|
|
36
|
+
# docwright
|
|
37
37
|
|
|
38
38
|
AI-powered documentation agent that watches your commits and keeps README and wiki pages up to date automatically.
|
|
39
39
|
|
|
@@ -43,7 +43,7 @@ AI-powered documentation agent that watches your commits and keeps README and wi
|
|
|
43
43
|
Developer commits / pushes
|
|
44
44
|
│
|
|
45
45
|
▼
|
|
46
|
-
CI runs
|
|
46
|
+
CI runs docwright
|
|
47
47
|
│
|
|
48
48
|
├─ First run?
|
|
49
49
|
│ └─ Generates all docs from scratch via LLM
|
|
@@ -63,12 +63,12 @@ The agent only rewrites `<!-- AUTO:section -->` blocks. Anything you write manua
|
|
|
63
63
|
Install into any repository:
|
|
64
64
|
|
|
65
65
|
```bash
|
|
66
|
-
pip install
|
|
67
|
-
|
|
66
|
+
pip install docwright
|
|
67
|
+
docwright install
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
This asks two questions (AI provider, commit mode) and creates:
|
|
71
|
-
- `.
|
|
71
|
+
- `.docwright/docwright.yml` — config
|
|
72
72
|
- `Makefile` targets: `make docs`, `make docs-sync`
|
|
73
73
|
- CI workflow (GitHub Actions or GitLab CI)
|
|
74
74
|
|
|
@@ -84,16 +84,16 @@ After that, docs update automatically on every push.
|
|
|
84
84
|
|
|
85
85
|
| Command | Description |
|
|
86
86
|
|---------|-------------|
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
89
|
-
| `
|
|
90
|
-
| `
|
|
91
|
-
| `
|
|
92
|
-
| `
|
|
87
|
+
| `docwright install` | Bootstrap a repository (interactive or `--auto`) |
|
|
88
|
+
| `docwright init` | Generate all documents from scratch |
|
|
89
|
+
| `docwright run` | Update changed sections based on latest diff |
|
|
90
|
+
| `docwright sync` | Force re-sync all AUTO sections |
|
|
91
|
+
| `docwright dashboard` | Terminal table of all registered projects |
|
|
92
|
+
| `docwright report` | Generate static HTML status report |
|
|
93
93
|
|
|
94
94
|
## Configuration
|
|
95
95
|
|
|
96
|
-
`.
|
|
96
|
+
`.docwright/docwright.yml`:
|
|
97
97
|
|
|
98
98
|
```yaml
|
|
99
99
|
provider:
|
|
@@ -146,7 +146,7 @@ Built-in templates cover the full documentation surface:
|
|
|
146
146
|
| `wiki/troubleshooting` | common_issues, diagnostics, known_limitations |
|
|
147
147
|
| `wiki/adr` | recent_decisions, decision_index |
|
|
148
148
|
|
|
149
|
-
Custom templates go in `.
|
|
149
|
+
Custom templates go in `.docwright/templates/` inside your repository.
|
|
150
150
|
|
|
151
151
|
## AUTO / MANUAL Sections
|
|
152
152
|
|
|
@@ -154,23 +154,23 @@ Custom templates go in `.ai-docgen/templates/` inside your repository.
|
|
|
154
154
|
# README
|
|
155
155
|
|
|
156
156
|
<!-- AUTO:overview -->
|
|
157
|
-
This section is managed by
|
|
157
|
+
This section is managed by docwright.
|
|
158
158
|
<!-- /AUTO:overview -->
|
|
159
159
|
|
|
160
160
|
<!-- MANUAL -->
|
|
161
161
|
## Contributing
|
|
162
162
|
|
|
163
|
-
Write whatever you want here —
|
|
163
|
+
Write whatever you want here — docwright never touches MANUAL blocks.
|
|
164
164
|
<!-- /MANUAL -->
|
|
165
165
|
```
|
|
166
166
|
|
|
167
167
|
## Central Registry
|
|
168
168
|
|
|
169
|
-
After `
|
|
169
|
+
After `docwright init`, the project is registered in a central `registry.yml`. View all projects:
|
|
170
170
|
|
|
171
171
|
```bash
|
|
172
|
-
|
|
173
|
-
|
|
172
|
+
docwright dashboard # terminal table
|
|
173
|
+
docwright report # HTML page at docwright-report.html
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
## Development
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# docwright
|
|
2
2
|
|
|
3
3
|
AI-powered documentation agent that watches your commits and keeps README and wiki pages up to date automatically.
|
|
4
4
|
|
|
@@ -8,7 +8,7 @@ AI-powered documentation agent that watches your commits and keeps README and wi
|
|
|
8
8
|
Developer commits / pushes
|
|
9
9
|
│
|
|
10
10
|
▼
|
|
11
|
-
CI runs
|
|
11
|
+
CI runs docwright
|
|
12
12
|
│
|
|
13
13
|
├─ First run?
|
|
14
14
|
│ └─ Generates all docs from scratch via LLM
|
|
@@ -28,12 +28,12 @@ The agent only rewrites `<!-- AUTO:section -->` blocks. Anything you write manua
|
|
|
28
28
|
Install into any repository:
|
|
29
29
|
|
|
30
30
|
```bash
|
|
31
|
-
pip install
|
|
32
|
-
|
|
31
|
+
pip install docwright
|
|
32
|
+
docwright install
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
This asks two questions (AI provider, commit mode) and creates:
|
|
36
|
-
- `.
|
|
36
|
+
- `.docwright/docwright.yml` — config
|
|
37
37
|
- `Makefile` targets: `make docs`, `make docs-sync`
|
|
38
38
|
- CI workflow (GitHub Actions or GitLab CI)
|
|
39
39
|
|
|
@@ -49,16 +49,16 @@ After that, docs update automatically on every push.
|
|
|
49
49
|
|
|
50
50
|
| Command | Description |
|
|
51
51
|
|---------|-------------|
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
56
|
-
| `
|
|
57
|
-
| `
|
|
52
|
+
| `docwright install` | Bootstrap a repository (interactive or `--auto`) |
|
|
53
|
+
| `docwright init` | Generate all documents from scratch |
|
|
54
|
+
| `docwright run` | Update changed sections based on latest diff |
|
|
55
|
+
| `docwright sync` | Force re-sync all AUTO sections |
|
|
56
|
+
| `docwright dashboard` | Terminal table of all registered projects |
|
|
57
|
+
| `docwright report` | Generate static HTML status report |
|
|
58
58
|
|
|
59
59
|
## Configuration
|
|
60
60
|
|
|
61
|
-
`.
|
|
61
|
+
`.docwright/docwright.yml`:
|
|
62
62
|
|
|
63
63
|
```yaml
|
|
64
64
|
provider:
|
|
@@ -111,7 +111,7 @@ Built-in templates cover the full documentation surface:
|
|
|
111
111
|
| `wiki/troubleshooting` | common_issues, diagnostics, known_limitations |
|
|
112
112
|
| `wiki/adr` | recent_decisions, decision_index |
|
|
113
113
|
|
|
114
|
-
Custom templates go in `.
|
|
114
|
+
Custom templates go in `.docwright/templates/` inside your repository.
|
|
115
115
|
|
|
116
116
|
## AUTO / MANUAL Sections
|
|
117
117
|
|
|
@@ -119,23 +119,23 @@ Custom templates go in `.ai-docgen/templates/` inside your repository.
|
|
|
119
119
|
# README
|
|
120
120
|
|
|
121
121
|
<!-- AUTO:overview -->
|
|
122
|
-
This section is managed by
|
|
122
|
+
This section is managed by docwright.
|
|
123
123
|
<!-- /AUTO:overview -->
|
|
124
124
|
|
|
125
125
|
<!-- MANUAL -->
|
|
126
126
|
## Contributing
|
|
127
127
|
|
|
128
|
-
Write whatever you want here —
|
|
128
|
+
Write whatever you want here — docwright never touches MANUAL blocks.
|
|
129
129
|
<!-- /MANUAL -->
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
## Central Registry
|
|
133
133
|
|
|
134
|
-
After `
|
|
134
|
+
After `docwright init`, the project is registered in a central `registry.yml`. View all projects:
|
|
135
135
|
|
|
136
136
|
```bash
|
|
137
|
-
|
|
138
|
-
|
|
137
|
+
docwright dashboard # terminal table
|
|
138
|
+
docwright report # HTML page at docwright-report.html
|
|
139
139
|
```
|
|
140
140
|
|
|
141
141
|
## Development
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
[tool.poetry]
|
|
2
2
|
name = "docwright"
|
|
3
|
-
version = "0.1.
|
|
3
|
+
version = "0.1.1"
|
|
4
4
|
description = "AI-powered documentation agent: auto-generates and maintains README & wiki on every commit"
|
|
5
5
|
authors = ["Artem Gotlib <gotlib.artem.m@gmail.com>"]
|
|
6
6
|
license = "MIT"
|
|
7
7
|
readme = "README.md"
|
|
8
|
-
homepage = "https://github.com/GotlibArtem/
|
|
9
|
-
repository = "https://github.com/GotlibArtem/
|
|
8
|
+
homepage = "https://github.com/GotlibArtem/docwright"
|
|
9
|
+
repository = "https://github.com/GotlibArtem/docwright"
|
|
10
10
|
keywords = ["documentation", "ai", "llm", "claude", "openai", "git", "automation"]
|
|
11
11
|
classifiers = [
|
|
12
12
|
"Development Status :: 3 - Alpha",
|
|
@@ -23,7 +23,7 @@ classifiers = [
|
|
|
23
23
|
packages = [{include = "ai_docgen"}]
|
|
24
24
|
|
|
25
25
|
[tool.poetry.scripts]
|
|
26
|
-
|
|
26
|
+
docwright = "ai_docgen.cli:cli"
|
|
27
27
|
|
|
28
28
|
[tool.poetry.dependencies]
|
|
29
29
|
python = "^3.11"
|
|
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
|
{docwright-0.1.0 → docwright-0.1.1}/ai_docgen/built_in_templates/wiki/development-guide.md.j2
RENAMED
|
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
|