Skip to content

docs+fix: EverOS-wrapper quickstart, ms-timestamp fix, live-validated - #14

Merged
dani1005 merged 3 commits into
v1from
docs/quickstart-wrapper
Jul 31, 2026
Merged

docs+fix: EverOS-wrapper quickstart, ms-timestamp fix, live-validated#14
dani1005 merged 3 commits into
v1from
docs/quickstart-wrapper

Conversation

@dani1005

Copy link
Copy Markdown
Collaborator

The PyPI project page (README) and quickstart still showed the low-level MemoryApi/ApiClient assembly from before the wrapper existed. Now that EverOS ships, lead with it.

  • README Quickstart → the EverOS wrapper snippet (5 lines instead of ~18). This is what renders on the PyPI project page.
  • quickstart.md → rewritten wrapper-first: add / flush / get / search / edit / delete / upload via client.*, plus a method table and a "Low-level typed client (advanced)" section preserving the typed MemoryApi/StorageApi usage (client.memory / client.storage).
  • ci.yml drift check → now maps each instance var to its class, so it validates the EverOS wrapper methods too (not just memory.* / storage.*).

Validated locally against the installed rc3 package: drift check resolves all 7 wrapper + 2 low-level methods, 18 wrapper tests green.

🤖 Generated with Claude Code

Dani and others added 2 commits July 31, 2026 12:58
Now that the ergonomic EverOS client ships, show it as the primary usage
instead of the low-level MemoryApi/ApiClient assembly.

- README Quickstart: EverOS wrapper snippet (this is the PyPI project page).
- quickstart.md: rewritten wrapper-first (add/flush/get/search/edit/delete/
  upload via client.*), with the typed low-level client kept as an Advanced
  section (client.memory / client.storage).
- ci.yml drift check: extended to map instance vars to their class, so it now
  validates EverOS wrapper methods in addition to MemoryApi/StorageApi.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Live validation against the real v2 API surfaced two issues:
- MessageItem.timestamp must be a unix MILLISECOND timestamp (>= 1e12); the
  wrapper defaulted to int(time.time()) (seconds), which the API rejects (422).
  Fixed to int(time.time() * 1000); tests + the low-level example use ms too.
- get/search require user_id or agent_id — the quickstart/README examples
  omitted it (422). Added user_id (+ a sender_id) so the walkthrough is
  self-consistent.

Verified: full live round-trip add->flush->get->search->upload->delete is green
against api.evermind.ai; 18 unit tests + drift check green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dani1005 dani1005 changed the title docs: lead quickstart with the EverOS wrapper docs+fix: EverOS-wrapper quickstart, ms-timestamp fix, live-validated Jul 31, 2026
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dani1005
dani1005 merged commit ed46505 into v1 Jul 31, 2026
1 check passed
@dani1005
dani1005 deleted the docs/quickstart-wrapper branch July 31, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant