fixyourdocs 0.2.0__tar.gz → 0.2.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.
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/CHANGELOG.md +9 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/CODE_OF_CONDUCT.md +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/CONTRIBUTING.md +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/PKG-INFO +3 -2
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/README.md +1 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/pyproject.toml +2 -2
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/__init__.py +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/_cli.py +0 -2
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_async_client.py +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_client.py +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_smoke.py +1 -1
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.github/scripts/check_snippet_drift.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.github/workflows/ci.yml +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.github/workflows/cla.yml +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.github/workflows/publish.yml +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.github/workflows/snippet-drift.yml +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/.gitignore +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/AGENTS.md +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/LICENSE +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/_http.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/_init.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/_results.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/client.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/errors.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/models.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/py.typed +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/src/fixyourdocs/snippet.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/__init__.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/fixtures/full.json +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/fixtures/golden-path.json +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/fixtures/invalid.json +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/fixtures/minimum-required.json +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_cli.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_init.py +0 -0
- {fixyourdocs-0.2.0 → fixyourdocs-0.2.1}/tests/test_models.py +0 -0
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## v0.2.1 — 2026-06-03
|
|
4
|
+
|
|
5
|
+
- Publish the dropped `View:` CLI line: `fixyourdocs report` no longer
|
|
6
|
+
prints a `View: https://hub.fixyourdocs.io/r/<id>` link (that route
|
|
7
|
+
404s; the code change merged in 0.2.0 but was never released). The Hub
|
|
8
|
+
also retired the public `GET /v1/reports/{id}` read endpoint — the SDK
|
|
9
|
+
is POST-only (`Client.send()`), so this is a release-only change with
|
|
10
|
+
no client API difference.
|
|
11
|
+
|
|
3
12
|
## v0.2.0 — 2026-05-26
|
|
4
13
|
|
|
5
14
|
- Add `fixyourdocs init` CLI (appends canonical snippet from `agents-md-snippet` to `AGENTS.md` / `CLAUDE.md` / `.cursor/rules` / `.github/copilot-instructions.md`; idempotent).
|
|
@@ -36,7 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when
|
|
|
36
36
|
|
|
37
37
|
## Enforcement
|
|
38
38
|
|
|
39
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@fixyourdocs.
|
|
39
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@fixyourdocs.io. All complaints will be reviewed and investigated promptly and fairly.
|
|
40
40
|
|
|
41
41
|
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
42
42
|
|
|
@@ -33,4 +33,4 @@ comment on your PR with a one-click sign-off link. See the CLA text at
|
|
|
33
33
|
|
|
34
34
|
By participating you agree to abide by the
|
|
35
35
|
[Code of Conduct](CODE_OF_CONDUCT.md) (Contributor Covenant 2.1).
|
|
36
|
-
Report incidents to <hello@fixyourdocs.
|
|
36
|
+
Report incidents to <hello@fixyourdocs.io>.
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: fixyourdocs
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.1
|
|
4
4
|
Summary: Reference Python SDK for the Docs Feedback Protocol
|
|
5
5
|
Project-URL: Homepage, https://docsfeedback.org
|
|
6
6
|
Project-URL: Repository, https://github.com/fixyourdocs/sdk-python
|
|
7
7
|
Project-URL: Specification, https://github.com/fixyourdocs/protocol
|
|
8
|
-
Author-email: FixYourDocs <hello@fixyourdocs.
|
|
8
|
+
Author-email: FixYourDocs <hello@fixyourdocs.io>
|
|
9
9
|
License-Expression: Apache-2.0
|
|
10
10
|
License-File: LICENSE
|
|
11
11
|
Keywords: agents,ai,docs,documentation,feedback,protocol
|
|
@@ -37,6 +37,7 @@ Reference Python SDK for the [Docs Feedback Protocol](https://github.com/fixyour
|
|
|
37
37
|
v0. The protocol lets AI agents file structured reports against
|
|
38
38
|
documentation pages when the docs break agent task flows.
|
|
39
39
|
|
|
40
|
+
- Full docs: <https://docs.fixyourdocs.io/sdk/python/>.
|
|
40
41
|
- Spec: <https://docsfeedback.org>.
|
|
41
42
|
- Why this exists: [the FixYourDocs manifesto](https://github.com/fixyourdocs/manifesto/blob/main/MANIFESTO.md).
|
|
42
43
|
|
|
@@ -4,6 +4,7 @@ Reference Python SDK for the [Docs Feedback Protocol](https://github.com/fixyour
|
|
|
4
4
|
v0. The protocol lets AI agents file structured reports against
|
|
5
5
|
documentation pages when the docs break agent task flows.
|
|
6
6
|
|
|
7
|
+
- Full docs: <https://docs.fixyourdocs.io/sdk/python/>.
|
|
7
8
|
- Spec: <https://docsfeedback.org>.
|
|
8
9
|
- Why this exists: [the FixYourDocs manifesto](https://github.com/fixyourdocs/manifesto/blob/main/MANIFESTO.md).
|
|
9
10
|
|
|
@@ -4,13 +4,13 @@ build-backend = "hatchling.build"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "fixyourdocs"
|
|
7
|
-
version = "0.2.
|
|
7
|
+
version = "0.2.1"
|
|
8
8
|
description = "Reference Python SDK for the Docs Feedback Protocol"
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
requires-python = ">=3.9"
|
|
11
11
|
license = "Apache-2.0"
|
|
12
12
|
license-files = ["LICENSE"]
|
|
13
|
-
authors = [{ name = "FixYourDocs", email = "hello@fixyourdocs.
|
|
13
|
+
authors = [{ name = "FixYourDocs", email = "hello@fixyourdocs.io" }]
|
|
14
14
|
keywords = ["docs", "documentation", "agents", "ai", "feedback", "protocol"]
|
|
15
15
|
classifiers = [
|
|
16
16
|
"Development Status :: 3 - Alpha",
|
|
@@ -145,7 +145,6 @@ def _do_report(
|
|
|
145
145
|
"id": result.id,
|
|
146
146
|
"received_at": result.received_at.isoformat(),
|
|
147
147
|
"is_duplicate": result.is_duplicate,
|
|
148
|
-
"url": f"{api_url}/r/{result.id}",
|
|
149
148
|
}
|
|
150
149
|
)
|
|
151
150
|
+ "\n"
|
|
@@ -153,7 +152,6 @@ def _do_report(
|
|
|
153
152
|
else:
|
|
154
153
|
label = "Duplicate report" if result.is_duplicate else "Report accepted"
|
|
155
154
|
stdout.write(f"{label}: {result.id}\n")
|
|
156
|
-
stdout.write(f"View: {api_url}/r/{result.id}\n")
|
|
157
155
|
return 0
|
|
158
156
|
|
|
159
157
|
|
|
@@ -86,7 +86,7 @@ async def test_headers_with_token_and_idempotency(golden_report: Report) -> None
|
|
|
86
86
|
assert headers["Authorization"] == "Bearer opaque-token"
|
|
87
87
|
assert headers["Idempotency-Key"] == "key-123"
|
|
88
88
|
assert headers["X-Docs-Feedback-Protocol-Version"] == "0"
|
|
89
|
-
assert headers["User-Agent"] == "fixyourdocs-python/0.2.
|
|
89
|
+
assert headers["User-Agent"] == "fixyourdocs-python/0.2.1"
|
|
90
90
|
|
|
91
91
|
|
|
92
92
|
@respx.mock
|
|
@@ -94,7 +94,7 @@ def test_default_headers_no_token(golden_report: Report) -> None:
|
|
|
94
94
|
headers = route.calls.last.request.headers
|
|
95
95
|
assert headers["Content-Type"].startswith("application/json")
|
|
96
96
|
assert headers["X-Docs-Feedback-Protocol-Version"] == "0"
|
|
97
|
-
assert headers["User-Agent"] == "fixyourdocs-python/0.2.
|
|
97
|
+
assert headers["User-Agent"] == "fixyourdocs-python/0.2.1"
|
|
98
98
|
assert "Authorization" not in headers
|
|
99
99
|
assert "Idempotency-Key" not in headers
|
|
100
100
|
|
|
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
|