pushary 2.4.1__tar.gz → 2.4.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.
Files changed (28) hide show
  1. {pushary-2.4.1 → pushary-2.4.2}/PKG-INFO +22 -4
  2. {pushary-2.4.1 → pushary-2.4.2}/README.md +20 -2
  3. {pushary-2.4.1 → pushary-2.4.2}/pyproject.toml +2 -2
  4. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/__init__.py +1 -1
  5. {pushary-2.4.1 → pushary-2.4.2}/.gitignore +0 -0
  6. {pushary-2.4.1 → pushary-2.4.2}/LICENSE +0 -0
  7. {pushary-2.4.1 → pushary-2.4.2}/examples/agno/README.md +0 -0
  8. {pushary-2.4.1 → pushary-2.4.2}/examples/dify/README.md +0 -0
  9. {pushary-2.4.1 → pushary-2.4.2}/examples/llamaindex/README.md +0 -0
  10. {pushary-2.4.1 → pushary-2.4.2}/examples/microsoft/README.md +0 -0
  11. {pushary-2.4.1 → pushary-2.4.2}/examples/stepfun/README.md +0 -0
  12. {pushary-2.4.1 → pushary-2.4.2}/examples/strands/README.md +0 -0
  13. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/_types.py +0 -0
  14. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/_util.py +0 -0
  15. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/adapters.py +0 -0
  16. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/client.py +0 -0
  17. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/decisions.py +0 -0
  18. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/errors.py +0 -0
  19. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/keys.py +0 -0
  20. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/py.typed +0 -0
  21. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/reminders.py +0 -0
  22. {pushary-2.4.1 → pushary-2.4.2}/src/pushary/webhook.py +0 -0
  23. {pushary-2.4.1 → pushary-2.4.2}/tests/test_adapters.py +0 -0
  24. {pushary-2.4.1 → pushary-2.4.2}/tests/test_agent.py +0 -0
  25. {pushary-2.4.1 → pushary-2.4.2}/tests/test_client.py +0 -0
  26. {pushary-2.4.1 → pushary-2.4.2}/tests/test_reminders.py +0 -0
  27. {pushary-2.4.1 → pushary-2.4.2}/tests/test_stepfun_example.py +0 -0
  28. {pushary-2.4.1 → pushary-2.4.2}/tests/test_webhook.py +0 -0
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: pushary
3
- Version: 2.4.1
3
+ Version: 2.4.2
4
4
  Summary: Human-in-the-loop (HITL) for AI agents: ask a person for approvals or answers by push notification.
5
5
  Project-URL: Homepage, https://pushary.com
6
- Project-URL: Documentation, https://pushary.com/docs
6
+ Project-URL: Documentation, https://pushary.com/docs/agents/build/quickstart
7
7
  Project-URL: Repository, https://github.com/Pushary/pushary-python
8
8
  Project-URL: Issues, https://github.com/Pushary/pushary-python/issues
9
9
  Author-email: Pushary <aadil@pushary.com>
@@ -38,6 +38,15 @@ dependency (Python standard library only) and targets Python 3.9 and newer.
38
38
  - A Pushary Partner plan, from $99 a month. [Start the trial](https://pushary.com/sign-up?from=agent&plan=partner&utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
39
39
  - An API key from [Partner onboarding](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start), set as `PUSHARY_API_KEY`.
40
40
  - Your users install the free Pushary app ([iPhone](https://apps.apple.com/us/app/pushary/id6785677563), [Android](https://play.google.com/store/apps/details?id=com.pushary.app)). They never sign up or pay.
41
+ - For [personal reminders](#personal-reminders) on your own phone: the Agent, Agent Pro or Team plan. All plans are on the [pricing page](https://pushary.com/pricing?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme).
42
+
43
+ ## What your users get
44
+
45
+ 1. They open the link from `enroll()` once. It shows your product's name and logo and connects their phone.
46
+ 2. When your agent calls `decisions.ask()`, a push notification titled with your product name arrives, such as **Acme needs your approval**. On iPhone, yes or no works from the lock screen. Choices and typed answers open the app.
47
+ 3. Your code gets the answer. A denial, an expired question or no answer at all gives `approved` as `False`.
48
+
49
+ Pushary hosts the phone delivery, the decision record, the webhooks and the [audit log](https://pushary.com/docs/agents/audit-log?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme). Your app keeps its own sign-in, the `external_id` for each user and the action itself.
41
50
 
42
51
  ## Installation
43
52
 
@@ -48,8 +57,8 @@ pip install pushary
48
57
  ## API key
49
58
 
50
59
  The SDK needs your full API key (`pk_xxx.sk_xxx`), which includes the secret
51
- half. Never expose it in client-side code. Get your key from your
52
- [Pushary dashboard](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
60
+ half. Never expose it in client-side code. Get your key from
61
+ [Partner onboarding](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
53
62
 
54
63
  ```python
55
64
  import os
@@ -297,8 +306,17 @@ These keys intentionally differ from 2.0. Do not replay completed operations dur
297
306
  ### Upgrading to 2.2
298
307
 
299
308
  `ApprovalAsk` accepts `context`. The shared approval gate sends it with the decision, so the approver can read what the notification cannot fit, such as a tool's full arguments. Context is part of the approval identity when set. An ask without context keeps the key it had in 2.1, so pending approvals carry over.
309
+
300
310
  ## Personal reminders
301
311
 
302
312
  On an active Agent workspace, `client.reminders.schedule("Check the deploy", in_minutes=30)` saves a one-time reminder that survives the agent exiting. Use `at` with an explicit UTC offset for calendar times, up to 30 days away. `client.reminders.list()` lists your pending reminders; `client.reminders.cancel(reminder_id)` cancels one before dispatch starts. Confirm the returned `reminder.fireAt`. Delivery requires a connected phone and can be about a minute late. These personal reminders do not schedule agent work or Partner customer campaigns.
303
313
 
304
314
  Personal reminder bodies must fit 180 UTF-16 units after secret redaction (most emoji use two); titles must fit 100. Oversized text is rejected. Listing and cancelling accepted reminders remain available when billing access closes.
315
+
316
+ ## Links
317
+
318
+ - [Human in the loop for AI agents](https://pushary.com/human-in-the-loop?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), with one page per framework.
319
+ - [Builder quickstart](https://pushary.com/docs/agents/build/quickstart?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), with Python and TypeScript, and the full [Partner guide](https://pushary.com/docs/agents/embed?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme).
320
+ - [Partner plan](https://pushary.com/partners?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), from $99 a month.
321
+ - [Browser demo](https://pushary.com/try?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme) of one approval.
322
+ - Built on this SDK: the [LangGraph](https://github.com/Pushary/pushary-langgraph), [CrewAI](https://github.com/Pushary/pushary-crewai) and [Haystack](https://github.com/Pushary/pushary-haystack) adapters. The TypeScript version is [`@pushary/server`](https://github.com/Pushary/pushary-server).
@@ -10,6 +10,15 @@ dependency (Python standard library only) and targets Python 3.9 and newer.
10
10
  - A Pushary Partner plan, from $99 a month. [Start the trial](https://pushary.com/sign-up?from=agent&plan=partner&utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
11
11
  - An API key from [Partner onboarding](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start), set as `PUSHARY_API_KEY`.
12
12
  - Your users install the free Pushary app ([iPhone](https://apps.apple.com/us/app/pushary/id6785677563), [Android](https://play.google.com/store/apps/details?id=com.pushary.app)). They never sign up or pay.
13
+ - For [personal reminders](#personal-reminders) on your own phone: the Agent, Agent Pro or Team plan. All plans are on the [pricing page](https://pushary.com/pricing?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme).
14
+
15
+ ## What your users get
16
+
17
+ 1. They open the link from `enroll()` once. It shows your product's name and logo and connects their phone.
18
+ 2. When your agent calls `decisions.ask()`, a push notification titled with your product name arrives, such as **Acme needs your approval**. On iPhone, yes or no works from the lock screen. Choices and typed answers open the app.
19
+ 3. Your code gets the answer. A denial, an expired question or no answer at all gives `approved` as `False`.
20
+
21
+ Pushary hosts the phone delivery, the decision record, the webhooks and the [audit log](https://pushary.com/docs/agents/audit-log?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme). Your app keeps its own sign-in, the `external_id` for each user and the action itself.
13
22
 
14
23
  ## Installation
15
24
 
@@ -20,8 +29,8 @@ pip install pushary
20
29
  ## API key
21
30
 
22
31
  The SDK needs your full API key (`pk_xxx.sk_xxx`), which includes the secret
23
- half. Never expose it in client-side code. Get your key from your
24
- [Pushary dashboard](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
32
+ half. Never expose it in client-side code. Get your key from
33
+ [Partner onboarding](https://pushary.com/onboarding/partner?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=partner-start).
25
34
 
26
35
  ```python
27
36
  import os
@@ -269,8 +278,17 @@ These keys intentionally differ from 2.0. Do not replay completed operations dur
269
278
  ### Upgrading to 2.2
270
279
 
271
280
  `ApprovalAsk` accepts `context`. The shared approval gate sends it with the decision, so the approver can read what the notification cannot fit, such as a tool's full arguments. Context is part of the approval identity when set. An ask without context keeps the key it had in 2.1, so pending approvals carry over.
281
+
272
282
  ## Personal reminders
273
283
 
274
284
  On an active Agent workspace, `client.reminders.schedule("Check the deploy", in_minutes=30)` saves a one-time reminder that survives the agent exiting. Use `at` with an explicit UTC offset for calendar times, up to 30 days away. `client.reminders.list()` lists your pending reminders; `client.reminders.cancel(reminder_id)` cancels one before dispatch starts. Confirm the returned `reminder.fireAt`. Delivery requires a connected phone and can be about a minute late. These personal reminders do not schedule agent work or Partner customer campaigns.
275
285
 
276
286
  Personal reminder bodies must fit 180 UTF-16 units after secret redaction (most emoji use two); titles must fit 100. Oversized text is rejected. Listing and cancelling accepted reminders remain available when billing access closes.
287
+
288
+ ## Links
289
+
290
+ - [Human in the loop for AI agents](https://pushary.com/human-in-the-loop?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), with one page per framework.
291
+ - [Builder quickstart](https://pushary.com/docs/agents/build/quickstart?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), with Python and TypeScript, and the full [Partner guide](https://pushary.com/docs/agents/embed?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme).
292
+ - [Partner plan](https://pushary.com/partners?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme), from $99 a month.
293
+ - [Browser demo](https://pushary.com/try?utm_source=github&utm_medium=oss-adapter&utm_campaign=pushary-python&utm_content=readme) of one approval.
294
+ - Built on this SDK: the [LangGraph](https://github.com/Pushary/pushary-langgraph), [CrewAI](https://github.com/Pushary/pushary-crewai) and [Haystack](https://github.com/Pushary/pushary-haystack) adapters. The TypeScript version is [`@pushary/server`](https://github.com/Pushary/pushary-server).
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "pushary"
7
- version = "2.4.1"
7
+ version = "2.4.2"
8
8
  description = "Human-in-the-loop (HITL) for AI agents: ask a person for approvals or answers by push notification."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -38,7 +38,7 @@ dependencies = []
38
38
 
39
39
  [project.urls]
40
40
  Homepage = "https://pushary.com"
41
- Documentation = "https://pushary.com/docs"
41
+ Documentation = "https://pushary.com/docs/agents/build/quickstart"
42
42
  Repository = "https://github.com/Pushary/pushary-python"
43
43
  Issues = "https://github.com/Pushary/pushary-python/issues"
44
44
 
@@ -23,7 +23,7 @@ from .reminders import RemindersResource
23
23
  from .errors import PusharyError
24
24
  from .webhook import SIGNATURE_HEADER, parse_decision_callback, verify_webhook_signature
25
25
 
26
- __version__ = "2.4.1"
26
+ __version__ = "2.4.2"
27
27
 
28
28
  __all__ = [
29
29
  "PusharyServer",
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