Skip to content

Commit 8695a58

Browse files
authored
docs: align Python SDK publish workflow and install guidance (#24)
* docs: overhaul README structure and narrative Rewrite root README with integrated diagrams, repository context, cross-repo references, and explicit alpha feedback contact details. * docs: add README-linked diagram assets Add SVG assets referenced by the root README so diagrams render correctly in GitHub for this repository. * docs: update alpha access and contact links Set alpha access URL to https://cloud.axme.ai/alpha and keep hello@axme.ai for contact and suggestions. * docs: align Python SDK docs with publish plan Switch install and quickstart guidance to current API behavior, rename the package target to `axme`, and add a GitHub Actions workflow for PyPI publishing via repository secret.
1 parent 5e8a63c commit 8695a58

3 files changed

Lines changed: 69 additions & 7 deletions

File tree

.github/workflows/publish-pypi.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: publish-pypi
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
tags:
7+
- "v*"
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: read
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: "3.11"
22+
23+
- name: Build distribution
24+
run: |
25+
python -m pip install --upgrade pip
26+
python -m pip install build
27+
python -m build
28+
29+
- name: Upload dist artifact
30+
uses: actions/upload-artifact@v4
31+
with:
32+
name: python-dist
33+
path: dist/
34+
35+
publish:
36+
runs-on: ubuntu-latest
37+
needs: build
38+
permissions:
39+
contents: read
40+
steps:
41+
- name: Download dist artifact
42+
uses: actions/download-artifact@v4
43+
with:
44+
name: python-dist
45+
path: dist/
46+
47+
- name: Publish to PyPI
48+
uses: pypa/gh-action-pypi-publish@release/v1
49+
with:
50+
password: ${{ secrets.PYPI_API_TOKEN }}
51+
skip-existing: true

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ The AXME Python SDK gives you a fully typed client for the AXME platform. You ca
2222
## Install
2323

2424
```bash
25-
pip install axme-sdk
25+
python -m pip install "git+https://github.com/AxmeAI/axme-sdk-python.git"
2626
```
2727

28+
PyPI publication target: `axme` (pending registry credentials and first public release).
2829
For local development from source:
2930

3031
```bash
@@ -118,11 +119,18 @@ for event in client.observe(intent["intent_id"]):
118119

119120
```python
120121
# Fetch pending approvals for an agent
121-
pending = client.list_inbox({"owner_agent": "agent://manager", "status": "PENDING"})
122-
123-
for item in pending["items"]:
124-
# Approve with a note
125-
client.resolve_approval(item["intent_id"], {"decision": "approved", "note": "LGTM"})
122+
pending = client.list_inbox(owner_agent="agent://manager")
123+
124+
for item in pending.get("items", []):
125+
thread_id = item.get("thread_id")
126+
if not thread_id:
127+
continue
128+
# Approve the inbox thread with a note
129+
client.approve_inbox_thread(
130+
thread_id,
131+
{"note": "LGTM"},
132+
owner_agent="agent://manager",
133+
)
126134
```
127135

128136
---

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["hatchling>=1.25.0"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "axme-sdk"
6+
name = "axme"
77
version = "0.1.0"
88
description = "Official Python SDK for Axme APIs."
99
readme = "README.md"
@@ -15,5 +15,8 @@ dependencies = ["httpx>=0.27.0,<1.0.0"]
1515
[project.optional-dependencies]
1616
dev = ["pytest>=9.0.0,<10.0.0"]
1717

18+
[tool.hatch.build.targets.wheel]
19+
packages = ["axme_sdk"]
20+
1821
[tool.pytest.ini_options]
1922
testpaths = ["tests"]

0 commit comments

Comments
 (0)