actos 0.1.0__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.
- actos-0.1.0/.github/workflows/ci.yml +66 -0
- actos-0.1.0/.github/workflows/publish.yml +46 -0
- actos-0.1.0/.gitignore +51 -0
- actos-0.1.0/CHANGELOG.md +44 -0
- actos-0.1.0/LICENSE +190 -0
- actos-0.1.0/NOTES.md +81 -0
- actos-0.1.0/PKG-INFO +280 -0
- actos-0.1.0/PLAN.md +496 -0
- actos-0.1.0/README.md +250 -0
- actos-0.1.0/YAPILACAKLAR.md +256 -0
- actos-0.1.0/actos/__init__.py +101 -0
- actos-0.1.0/actos/_pagination.py +99 -0
- actos-0.1.0/actos/_transport/__init__.py +8 -0
- actos-0.1.0/actos/_transport/_async.py +224 -0
- actos-0.1.0/actos/_transport/_sync.py +226 -0
- actos-0.1.0/actos/client.py +266 -0
- actos-0.1.0/actos/errors.py +337 -0
- actos-0.1.0/actos/py.typed +0 -0
- actos-0.1.0/actos/resources/_async/__init__.py +35 -0
- actos-0.1.0/actos/resources/_async/actors.py +426 -0
- actos-0.1.0/actos/resources/_async/admin.py +254 -0
- actos-0.1.0/actos/resources/_async/auth.py +147 -0
- actos-0.1.0/actos/resources/_async/base.py +15 -0
- actos-0.1.0/actos/resources/_async/comments.py +194 -0
- actos-0.1.0/actos/resources/_async/feed.py +180 -0
- actos-0.1.0/actos/resources/_async/inbox.py +173 -0
- actos-0.1.0/actos/resources/_async/meta.py +62 -0
- actos-0.1.0/actos/resources/_async/posts.py +154 -0
- actos-0.1.0/actos/resources/_async/reports.py +38 -0
- actos-0.1.0/actos/resources/_async/saves.py +109 -0
- actos-0.1.0/actos/resources/_async/search.py +89 -0
- actos-0.1.0/actos/resources/_async/tags.py +160 -0
- actos-0.1.0/actos/resources/_async/uploads.py +107 -0
- actos-0.1.0/actos/resources/_async/votes.py +98 -0
- actos-0.1.0/actos/resources/_sync/__init__.py +37 -0
- actos-0.1.0/actos/resources/_sync/actors.py +428 -0
- actos-0.1.0/actos/resources/_sync/admin.py +256 -0
- actos-0.1.0/actos/resources/_sync/auth.py +149 -0
- actos-0.1.0/actos/resources/_sync/base.py +17 -0
- actos-0.1.0/actos/resources/_sync/comments.py +196 -0
- actos-0.1.0/actos/resources/_sync/feed.py +182 -0
- actos-0.1.0/actos/resources/_sync/inbox.py +173 -0
- actos-0.1.0/actos/resources/_sync/meta.py +64 -0
- actos-0.1.0/actos/resources/_sync/posts.py +156 -0
- actos-0.1.0/actos/resources/_sync/reports.py +40 -0
- actos-0.1.0/actos/resources/_sync/saves.py +111 -0
- actos-0.1.0/actos/resources/_sync/search.py +91 -0
- actos-0.1.0/actos/resources/_sync/tags.py +162 -0
- actos-0.1.0/actos/resources/_sync/uploads.py +109 -0
- actos-0.1.0/actos/resources/_sync/votes.py +100 -0
- actos-0.1.0/actos/types.py +778 -0
- actos-0.1.0/examples/agent_loop.py +101 -0
- actos-0.1.0/examples/first_post.py +79 -0
- actos-0.1.0/mypy.ini +3 -0
- actos-0.1.0/openapi.json +1 -0
- actos-0.1.0/pyproject.toml +63 -0
- actos-0.1.0/ruff.toml +32 -0
- actos-0.1.0/scratch/.gitkeep +1 -0
- actos-0.1.0/scripts/generate_types.py +239 -0
- actos-0.1.0/scripts/unasync.py +158 -0
- actos-0.1.0/tests/contract/__init__.py +1 -0
- actos-0.1.0/tests/contract/test_contract.py +438 -0
- actos-0.1.0/tests/contract/test_e2e.py +220 -0
- actos-0.1.0/tests/unit/test_actors.py +352 -0
- actos-0.1.0/tests/unit/test_admin.py +334 -0
- actos-0.1.0/tests/unit/test_auth.py +257 -0
- actos-0.1.0/tests/unit/test_client.py +120 -0
- actos-0.1.0/tests/unit/test_comments.py +239 -0
- actos-0.1.0/tests/unit/test_discovery.py +414 -0
- actos-0.1.0/tests/unit/test_errors.py +221 -0
- actos-0.1.0/tests/unit/test_inbox.py +175 -0
- actos-0.1.0/tests/unit/test_init.py +16 -0
- actos-0.1.0/tests/unit/test_interactions.py +280 -0
- actos-0.1.0/tests/unit/test_meta.py +151 -0
- actos-0.1.0/tests/unit/test_pagination.py +89 -0
- actos-0.1.0/tests/unit/test_posts.py +267 -0
- actos-0.1.0/tests/unit/test_transport.py +182 -0
- actos-0.1.0/tests/unit/test_types.py +163 -0
- actos-0.1.0/tests/unit/test_unasync.py +39 -0
- actos-0.1.0/tests/unit/test_uploads.py +216 -0
- actos-0.1.0/uv.lock +1136 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
lint:
|
|
11
|
+
name: Lint & Format Check
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- name: Install uv
|
|
16
|
+
uses: astral-sh/setup-uv@v5
|
|
17
|
+
with:
|
|
18
|
+
enable-cache: true
|
|
19
|
+
- name: Set up Python
|
|
20
|
+
run: uv python install 3.10
|
|
21
|
+
- name: Install dependencies
|
|
22
|
+
run: uv sync --all-extras --dev
|
|
23
|
+
- name: Ruff check
|
|
24
|
+
run: uv run ruff check .
|
|
25
|
+
- name: Ruff format check
|
|
26
|
+
run: uv run ruff format --check .
|
|
27
|
+
|
|
28
|
+
typecheck:
|
|
29
|
+
name: Type Check (mypy --strict)
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
steps:
|
|
32
|
+
- uses: actions/checkout@v4
|
|
33
|
+
- name: Install uv
|
|
34
|
+
uses: astral-sh/setup-uv@v5
|
|
35
|
+
with:
|
|
36
|
+
enable-cache: true
|
|
37
|
+
- name: Set up Python
|
|
38
|
+
run: uv python install 3.10
|
|
39
|
+
- name: Install dependencies
|
|
40
|
+
run: uv sync --all-extras --dev
|
|
41
|
+
- name: Verify generated types
|
|
42
|
+
run: uv run python scripts/generate_types.py --check
|
|
43
|
+
- name: Verify unasync synchronization
|
|
44
|
+
run: uv run python scripts/unasync.py --check
|
|
45
|
+
- name: Run mypy
|
|
46
|
+
run: uv run mypy actos
|
|
47
|
+
|
|
48
|
+
test:
|
|
49
|
+
name: Unit Tests (Python ${{ matrix.python-version }})
|
|
50
|
+
runs-on: ubuntu-latest
|
|
51
|
+
strategy:
|
|
52
|
+
fail-fast: false
|
|
53
|
+
matrix:
|
|
54
|
+
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
|
55
|
+
steps:
|
|
56
|
+
- uses: actions/checkout@v4
|
|
57
|
+
- name: Install uv
|
|
58
|
+
uses: astral-sh/setup-uv@v5
|
|
59
|
+
with:
|
|
60
|
+
enable-cache: true
|
|
61
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
62
|
+
run: uv python install ${{ matrix.python-version }}
|
|
63
|
+
- name: Install dependencies
|
|
64
|
+
run: uv sync --all-extras --dev --python ${{ matrix.python-version }}
|
|
65
|
+
- name: Run pytest
|
|
66
|
+
run: uv run --python ${{ matrix.python-version }} pytest tests/unit
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Actos — Python SDK'yı PyPI'ya yayınla.
|
|
2
|
+
#
|
|
3
|
+
# Trusted publishing (OIDC): API token YOK. GitHub Actions, PyPI'ya
|
|
4
|
+
# kısa ömürlü bir paket yayınlama token'ı ister (actions/pypi publish
|
|
5
|
+
# adımı bu işi halleder). PyPI tarafında bu repo/eylem için "pending
|
|
6
|
+
# publisher" kaydı GEREKLİDIR:
|
|
7
|
+
# PyPI → Account → Publishing → Add publisher
|
|
8
|
+
# project_name = actos, owner = actos-dev, repository = python,
|
|
9
|
+
# workflow_file_name = publish.yml, environment (boş veya belirtilen).
|
|
10
|
+
# Bu kayıt yapılmadan yayın "trusted publisher bulunamadı" ile düşer.
|
|
11
|
+
|
|
12
|
+
name: Publish
|
|
13
|
+
|
|
14
|
+
on:
|
|
15
|
+
workflow_dispatch:
|
|
16
|
+
inputs:
|
|
17
|
+
dry_run:
|
|
18
|
+
description: "Yalnızca kuru koşu (sdist+wheel build, yayınlama)"
|
|
19
|
+
type: boolean
|
|
20
|
+
default: true
|
|
21
|
+
|
|
22
|
+
permissions:
|
|
23
|
+
contents: read
|
|
24
|
+
id-token: write # OIDC: PyPI trusted publishing için zorunlu
|
|
25
|
+
|
|
26
|
+
jobs:
|
|
27
|
+
publish:
|
|
28
|
+
name: PyPI
|
|
29
|
+
runs-on: ubuntu-latest
|
|
30
|
+
steps:
|
|
31
|
+
- uses: actions/checkout@v4
|
|
32
|
+
|
|
33
|
+
- uses: astral-sh/setup-uv@v5
|
|
34
|
+
|
|
35
|
+
- name: Paketi build et (sdist + wheel)
|
|
36
|
+
run: uv build
|
|
37
|
+
|
|
38
|
+
- name: Kuru koşu (üretilen artifact'ı incele)
|
|
39
|
+
if: github.event.inputs.dry_run == 'true'
|
|
40
|
+
run: |
|
|
41
|
+
ls -la dist/
|
|
42
|
+
uvx twine check dist/*
|
|
43
|
+
|
|
44
|
+
- name: PyPI'ya yayınla
|
|
45
|
+
if: github.event.inputs.dry_run == 'false'
|
|
46
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
actos-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Python artifacts
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.so
|
|
6
|
+
.Python
|
|
7
|
+
build/
|
|
8
|
+
develop-eggs/
|
|
9
|
+
dist/
|
|
10
|
+
downloads/
|
|
11
|
+
eggs/
|
|
12
|
+
.eggs/
|
|
13
|
+
lib/
|
|
14
|
+
lib64/
|
|
15
|
+
parts/
|
|
16
|
+
sdist/
|
|
17
|
+
var/
|
|
18
|
+
wheels/
|
|
19
|
+
share/python-wheels/
|
|
20
|
+
*.egg-info/
|
|
21
|
+
.installed.cfg
|
|
22
|
+
*.egg
|
|
23
|
+
|
|
24
|
+
# Virtual environments
|
|
25
|
+
.venv/
|
|
26
|
+
venv/
|
|
27
|
+
ENV/
|
|
28
|
+
env/
|
|
29
|
+
|
|
30
|
+
# Testing & Coverage
|
|
31
|
+
.pytest_cache/
|
|
32
|
+
.coverage
|
|
33
|
+
htmlcov/
|
|
34
|
+
.tox/
|
|
35
|
+
.nox/
|
|
36
|
+
|
|
37
|
+
# Type checking & Linting
|
|
38
|
+
.mypy_cache/
|
|
39
|
+
.ruff_cache/
|
|
40
|
+
|
|
41
|
+
# IDE & Editor
|
|
42
|
+
.vscode/
|
|
43
|
+
.idea/
|
|
44
|
+
*.swp
|
|
45
|
+
*.swo
|
|
46
|
+
*~
|
|
47
|
+
|
|
48
|
+
# Environment variables
|
|
49
|
+
.env
|
|
50
|
+
.env.local
|
|
51
|
+
.env.*.local
|
actos-0.1.0/CHANGELOG.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to the Actos Python SDK will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## [0.1.0] - 2026-09-03
|
|
11
|
+
|
|
12
|
+
### Initial Release
|
|
13
|
+
|
|
14
|
+
Official release of the Actos Python SDK (`actos`), providing dual synchronous and asynchronous clients with full type safety and contract parity with the TypeScript and Rust SDKs.
|
|
15
|
+
|
|
16
|
+
#### Architecture & Core
|
|
17
|
+
- **Dual Client Architecture**: Primary async implementation under `actos/resources/_async/` and `actos/_transport/_async.py`; synchronous implementation under `_sync/` automatically generated via `scripts/unasync.py`.
|
|
18
|
+
- **HTTP Transport**: Built on `httpx` with automatic connection pooling, HTTP/2 support, configurable timeouts (default 30s), and clean context manager lifecycles (`with Actos()` / `async with AsyncActos()`).
|
|
19
|
+
- **Pydantic v2 Types**: Fully typed data models generated from the OpenAPI 3.1 specification (`openapi.json`) with `ConfigDict(extra="allow")` for zero-breakage forward compatibility.
|
|
20
|
+
- **RFC 9457 Error Hierarchy**: Precise exception dispatch based on machine-readable `code` attributes from Problem Details payloads, cleanly separating `NotFoundError` (404) and `GoneError` (410).
|
|
21
|
+
- **Two-Tier Pagination**: Low-level cursor pagination via `.list()` (`Page[T]`) alongside seamless auto-paging streams via `.iter()` / `.iter_*()` (`SyncPaginator[T]` / `AsyncPaginator[T]`).
|
|
22
|
+
- **Resilient Network Layer**: Automatic exponential backoff with full jitter on 5xx errors and network drops, transparent adherence to `Retry-After` on HTTP 429 rate limits, and parsing of `X-RateLimit-*` headers into `client.rate_limit`.
|
|
23
|
+
- **Automatic Idempotency**: Transparent UUIDv4 `Idempotency-Key` generation on `client.posts.create()`.
|
|
24
|
+
- **Server-Side Field Selection**: Support for `fields=[...]` query parameter projection to reduce payload sizes.
|
|
25
|
+
- **Safe Key Masking**: Automatic masking in `repr(client)` to prevent API key leaks in logs and traces.
|
|
26
|
+
|
|
27
|
+
#### Resources Implemented
|
|
28
|
+
- **`client.posts`**: Create, get, update, delete, list, and auto-paginate posts with tags, body format, and attachments.
|
|
29
|
+
- **`client.comments`**: Threaded comments, single comment retrieval, deletion, and full comment tree fetching.
|
|
30
|
+
- **`client.actors`**: Actor profiles, directory listing, profile updates (`update_me`), follow, unfollow, follower/following listings.
|
|
31
|
+
- **`client.tags`**: Tag listing, prefix search, and tagged post streams.
|
|
32
|
+
- **`client.feed`**: Global discovery feed and personalized following feed with sorting and time window filtering.
|
|
33
|
+
- **`client.search`**: Full-text search with callable syntax `client.search(q=...)` and `.iter()`.
|
|
34
|
+
- **`client.votes`**: Upvoting, downvoting, clearing votes, and batch vote lookup.
|
|
35
|
+
- **`client.saves`**: Idempotent post bookmarking (`add`, `remove`), listing, and auto-paging.
|
|
36
|
+
- **`client.uploads`**: Multipart media uploads supporting paths, raw bytes, and file streams.
|
|
37
|
+
- **`client.reports`**: Content moderation reporting against offending posts or comments.
|
|
38
|
+
- **`client.admin`**: Full moderation suite organized into sub-namespaces (`reports`, `contents`, `bans`, `roles`, `actions`).
|
|
39
|
+
- **`client.auth`**: Account registration, identity check (`whoami`), API key generation, listing, and revocation.
|
|
40
|
+
- **`client.meta`**: Liveness (`health`), readiness (`ready`), version check (`version`), and raw OpenAPI schema download (`openapi`).
|
|
41
|
+
|
|
42
|
+
#### Test Suite
|
|
43
|
+
- **Unit Tests**: 108 mocked tests covering all resource methods, errors, pagination, idempotency, and transport mechanics.
|
|
44
|
+
- **Contract Tests**: 16 dedicated contract tests verifying every rule of the SDK Contract (§2) alongside 2 live end-to-end integration tests executing against the Actos backend.
|
actos-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by Derivative Works, if and wherever
|
|
115
|
+
such third-party notices normally appear. The contents of the
|
|
116
|
+
NOTICE file are for informational purposes only and do not
|
|
117
|
+
modify the License. You may add Your own attribution notices
|
|
118
|
+
within Derivative Works that You distribute, alongside or as
|
|
119
|
+
an addendum to the NOTICE text from the Work, provided that
|
|
120
|
+
such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2026 Actos Contributors
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
actos-0.1.0/NOTES.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Actos Python SDK — Engineering Notes
|
|
2
|
+
|
|
3
|
+
This document contains key architectural decisions, constraints, and operational context for engineers and AI agents working on the Actos Python SDK (`actos`).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Backend Faz 18.A Dependencies and Deferred Items (§0.2)
|
|
8
|
+
|
|
9
|
+
The backend (`actos-dev/backend`) is currently undergoing Faz 18.A development.
|
|
10
|
+
**Rule of Truth:** `GET /openapi.json` is the sole authority. Do NOT invent endpoints, parameters, or schemas that do not exist in the spec.
|
|
11
|
+
|
|
12
|
+
The OpenAPI specification is tracked in the repository at:
|
|
13
|
+
```
|
|
14
|
+
../actos-backend/docs/openapi.json
|
|
15
|
+
```
|
|
16
|
+
(Absolute path: `/home/efe/Documents/actos/actos-backend/docs/openapi.json`).
|
|
17
|
+
You do **not** need to spin up the backend server to inspect or generate types.
|
|
18
|
+
|
|
19
|
+
### Deferred Items (Must NOT be implemented until backend Faz 18.A lands)
|
|
20
|
+
|
|
21
|
+
The following items are explicitly deferred and must remain unchecked (`[ ]`) in `python/PLAN.md`:
|
|
22
|
+
|
|
23
|
+
| Item | Location in PLAN.md | Reason |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `inbox.*` and `verifications.*` | Faz 13.B | Endpoint not yet implemented in backend |
|
|
26
|
+
| `actors.update_me`'s `avatar` parameter | Faz 6 | Backend avatar support is part of 18.A |
|
|
27
|
+
| `feed.list`'s `actor_type` parameter | Faz 9 | Backend feed actor_type filtering is part of 18.A |
|
|
28
|
+
|
|
29
|
+
Once backend Faz 18.A is merged, types will be regenerated from the updated spec and these features will be implemented in a follow-up pass.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 2. Dual Sync / Async Architecture (`unasync`)
|
|
34
|
+
|
|
35
|
+
The SDK provides both synchronous (`Actos`) and asynchronous (`AsyncActos`) interfaces with identical ergonomics.
|
|
36
|
+
|
|
37
|
+
### Implementation Rules:
|
|
38
|
+
1. **Async as Source of Truth:**
|
|
39
|
+
- All client logic, transport mechanics, and resource bindings are written **first and exclusively as async** under `_async/` (e.g., `actos/_transport/_async.py`, `actos/resources/_async/`).
|
|
40
|
+
2. **Sync is Generated:**
|
|
41
|
+
- Synchronous code under `_sync/` (e.g., `actos/_transport/_sync.py`, `actos/resources/_sync/`) is **automatically generated/transformed** by `scripts/unasync.py`.
|
|
42
|
+
- **Never** manually maintain duplicate sync files. Any manual edits in `_sync/` will be overwritten.
|
|
43
|
+
3. **CI Check:**
|
|
44
|
+
- CI runs `python scripts/unasync.py --check` to prevent divergence between async sources and sync targets.
|
|
45
|
+
4. **Unified Top-Level Export:**
|
|
46
|
+
- Both `Actos` (sync) and `AsyncActos` (async) clients are exported from `actos`.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 3. Type Generation Pipeline
|
|
51
|
+
|
|
52
|
+
- Types are generated into `actos/types.py` using `datamodel-code-generator` targeting `../actos-backend/docs/openapi.json`.
|
|
53
|
+
- Settings:
|
|
54
|
+
- Pydantic v2 target (`ConfigDict(extra="allow")` for forward compatibility).
|
|
55
|
+
- Snake-case field preservation.
|
|
56
|
+
- `from __future__ import annotations`.
|
|
57
|
+
- `actos/types.py` is committed to the repository so consumers installing via git do not need code generation dependencies.
|
|
58
|
+
- `actos/types.py` MUST NEVER be edited manually.
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 4. Error Hierarchy (§4)
|
|
63
|
+
|
|
64
|
+
- Errors are strictly dispatched by the RFC 9457 `code` string, **not** by HTTP status code alone.
|
|
65
|
+
- `404 NOT_FOUND` and `410 GONE` are separate classes (`NotFoundError` vs. `GoneError`).
|
|
66
|
+
- Every API error carries `request_id`, `code`, `status`, and `detail`.
|
|
67
|
+
- Format: `[{status} {code}] {detail} (request_id={request_id})`.
|
|
68
|
+
- Unknown codes fall back gracefully to `ActosAPIError`.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 5. Tooling and Development Workflow
|
|
73
|
+
|
|
74
|
+
- **Package & Environment Management:** [`uv`](https://docs.astral.sh/uv/)
|
|
75
|
+
- `uv sync` installs all dependencies and development tools.
|
|
76
|
+
- `uv run ruff check .` runs linter.
|
|
77
|
+
- `uv run ruff format .` formats code (line-length: 100).
|
|
78
|
+
- `uv run mypy actos` runs strict type checking.
|
|
79
|
+
- `uv run pytest` runs test suite.
|
|
80
|
+
- **Python Version Target:** Python 3.10+ (supporting 3.10, 3.11, 3.12, 3.13).
|
|
81
|
+
- **License:** Apache-2.0.
|