eve-memory-client 0.3.0__tar.gz

eve_memory_client-0.3.0/.gitignore

@@ -0,0 +1,9 @@
+.pytest_cache/
+.coverage
+dist/
+build/
+release/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd

eve_memory_client-0.3.0/LICENSE

@@ -0,0 +1,200 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but not
+      limited to compiled object code, generated documentation, and
+      conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an approval
+      from your organization if needed.
+
+   Copyright 2025 Sherif Kozman
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

eve_memory_client-0.3.0/PKG-INFO

@@ -0,0 +1,488 @@
+Metadata-Version: 2.4
+Name: eve-memory-client
+Version: 0.3.0
+Summary: Eve client installer and local tool integration CLI
+Project-URL: Homepage, https://evemem.com
+Project-URL: Repository, https://github.com/evememory/eve-client
+Project-URL: Issues, https://github.com/evememory/eve-client/issues
+Author: Sherif Kozman
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ai,cli,eve,installer,mcp,memory
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: keyring>=25.6
+Requires-Dist: mcp>=1.20
+Requires-Dist: rich>=13.0
+Requires-Dist: tomli-w>=1.2
+Requires-Dist: typer>=0.15
+Provides-Extra: server
+Requires-Dist: httpx>=0.27; extra == 'server'
+Requires-Dist: mcp>=1.20; extra == 'server'
+Description-Content-Type: text/markdown
+
+# Eve Memory Client
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python >= 3.11](https://img.shields.io/badge/python-%E2%89%A53.11-blue)](https://www.python.org/downloads/)
+[![MCP Compatible](https://img.shields.io/badge/MCP-compatible-brightgreen)](https://evemem.com)
+
+`eve-memory-client` is the Python distribution for the local `eve` CLI. It connects supported AI tools to the hosted Eve memory service.
+
+It detects local tools, configures MCP, installs Eve-managed prompt and hook files where supported, manages auth, and can verify, repair, or remove the integration later. It can also import local history from supported clients.
+
+## How Eve Works
+
+When you run `eve install`, Eve configures four lifecycle hooks that run automatically — no commands needed during your sessions.
+
+| Moment                | What Eve does                                                                                       |
+| --------------------- | --------------------------------------------------------------------------------------------------- |
+| **Session opens**     | Injects your saved preferences, learned rules, and recent session history directly into Claude      |
+| **Every prompt**      | Silently searches your memory and enriches each message with relevant context before Claude sees it |
+| **Before compaction** | Preserves critical facts before Claude's context window compresses                                  |
+| **Session ends**      | Reads the full transcript, extracts new learnings, and stores them for future sessions              |
+
+Lifecycle hooks are available on Claude Code and Gemini CLI. Eve also connects to Codex CLI and other MCP-compatible clients using prompt seeding, so you get memory across all your tools.
+
+## Quick Start — 5 minutes
+
+**1. Get an Eve workspace**
+
+Request access at [evemem.com](https://evemem.com). After provisioning, sign in and create an API key at [evemem.com/app/overview](https://evemem.com/app/overview).
+
+**2. Install the client**
+
+```bash
+uv tool install git+https://github.com/evememory/eve-client.git
+```
+
+No uv? Use:
+
+```bash
+pipx install git+https://github.com/evememory/eve-client.git
+```
+
+Verify: `eve version`
+
+**3. Connect Claude Code** (swap `--tool gemini-cli` for Gemini CLI)
+
+```bash
+eve connect --tool claude-code --api-key <your-eve-api-key>
+```
+
+This combines auth, install, and verify. For step-by-step, see [API key flow](#api-key-flow) below.
+
+Expected output:
+
+```
+✓ MCP config written
+✓ CLAUDE.md companion updated
+✓ Lifecycle hooks configured — Eve auto-injects memory context on every session
+✓ Eve memory is connected and responding
+```
+
+> **What just happened?** Eve installed four lifecycle hooks. From this point forward, every Claude Code session starts with your memory context pre-loaded, and ends with new learnings captured. You never need to ask Claude to use Eve.
+
+If `eve connect` fails: run `eve doctor --tool claude-code` and check the diagnostics output. Open an issue at [github.com/evememory/eve-client](https://github.com/evememory/eve-client/issues).
+
+**4. Test memory across sessions**
+
+In Claude Code, tell Claude:
+
+> "Remember that I use PostgreSQL with a users table — email and created_at columns."
+
+Start a **new** Claude Code session and ask:
+
+> "What database setup did I mention?"
+
+Claude will recall it via Eve. ✓
+
+See [`examples/`](./examples/) for manual MCP config snippets (no installer needed).
+
+## Install
+
+Before installing the client, get an Eve workspace:
+
+- Request access: [https://evemem.com](https://evemem.com)
+- After your workspace is provisioned, sign in to the Eve dashboard:
+  - [https://evemem.com/app/overview](https://evemem.com/app/overview)
+- If you plan to use API-key auth, create or rotate a tenant key from the Eve admin/user setup flow before connecting your client.
+
+### From GitHub now
+
+Preferred:
+
+```bash
+uv tool install git+https://github.com/evememory/eve-client.git
+```
+
+Alternative:
+
+```bash
+pipx install git+https://github.com/evememory/eve-client.git
+```
+
+Or via the standalone bash installer. Save it first; do not pipe remote shell directly into `sh`:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/evememory/eve-client/main/install.sh -o install-eve.sh
+sh install-eve.sh
+```
+
+Then confirm:
+
+```bash
+eve version
+eve --help
+```
+
+### Manual config (no installer)
+
+See [`examples/`](./examples/) for ready-to-paste MCP config snippets for Claude Code, Gemini CLI, and Codex CLI.
+
+### From PyPI
+
+The PyPI distribution is `eve-memory-client`; `eve-client` is not used as the
+PyPI name because that namespace is occupied by a third party.
+
+Install with:
+
+```bash
+uv tool install eve-memory-client
+```
+
+or:
+
+```bash
+pipx install eve-memory-client
+```
+
+## What Eve Client Does
+
+- detects supported local AI clients
+- shows an install plan before changing files
+- writes Eve-managed MCP config
+- installs prompt/companion files where supported
+- installs four lifecycle hooks that auto-inject memory context on every session (SessionStart, UserPromptSubmit, PreCompact, Stop)
+- stores auth locally using file-based credential storage
+- provides `eve memory search` and `eve memory status` commands for direct memory access
+- verifies, repairs, rolls back, and uninstalls Eve-managed changes
+- imports local conversation history into Eve from supported clients
+
+## Importing Local History
+
+Supported importer sources today:
+
+- Claude Code
+- Codex CLI
+- Gemini CLI
+
+Core commands:
+
+```bash
+eve import scan --source claude-code
+eve import preview --source claude-code --path <session_file>
+eve import jobs                              # list scan jobs
+eve auth login --tool claude-code
+eve import upload --job <scan_job_id> --use-auth-from claude-code
+eve import runs                              # list upload runs
+eve import resume --run <run_id>
+eve import cleanup --days 30
+eve import cleanup --days 30 --apply
+```
+
+How it works:
+
+- parses local history on your machine
+- uploads normalized batches to the managed Eve service
+- keeps a local SQLite ledger for scan jobs, upload runs, replay, and resume
+- supports dry-run cleanup of old completed local importer runs by default
+
+Importer maintenance:
+
+- `eve import cleanup` is a generic local ledger maintenance command, not a client-specific import source feature
+
+Auth note:
+
+- avoid passing secrets directly on the command line when possible
+- prefer `eve auth login ...` first, then run importer commands without repeating the API key
+- in an interactive shell, `eve auth login --tool claude-code` prompts for the key securely
+
+Current rollout note:
+
+- correctness and resume are solid
+- very large imports, especially Claude-heavy ones, may still be slower than ideal while batching defaults continue to be tuned
+
+## Supported Clients
+
+### Claude Code
+
+Supported today:
+
+- MCP config
+- `CLAUDE.md` companion file
+- package-managed hooks
+- importer support: `scan`, `preview`, `upload`, `resume`
+
+Primary auth path today:
+
+- Eve API key
+
+### Gemini CLI
+
+Supported today:
+
+- MCP config
+- `GEMINI.md` companion file
+- package-managed hooks
+- importer support: `scan`, `preview`, `upload`, `resume`
+
+Primary auth path today:
+
+- Eve API key
+
+### Codex CLI
+
+Supported today:
+
+- MCP config
+- Eve-owned OAuth login
+- runtime bearer token injection
+- importer support: `scan`, `preview`, `upload`, `resume`
+
+Primary auth path today:
+
+- Eve OAuth
+
+Important:
+
+- native Codex MCP login is **not** the supported Eve path
+
+### Claude Desktop
+
+Not auto-configured locally for hosted Eve.
+
+## Authentication Requirements
+
+You need an Eve workspace and either:
+
+- an Eve API key, or
+- Eve OAuth access for supported flows
+
+Current auth expectations:
+
+- Claude Code: API key
+- Gemini CLI: API key
+- Codex CLI: Eve OAuth
+
+OAuth browser flow exists for more clients, but it is still experimental outside the Codex path and should not be treated as the default production installer flow yet.
+
+## Basic Usage
+
+### First run
+
+```bash
+eve quickstart
+eve connect --tool claude-code
+eve verify --tool claude-code
+```
+
+### API key flow
+
+```bash
+eve auth login --tool claude-code --api-key <eve-key>
+eve install --tool claude-code --apply --yes  # --apply writes config, --yes skips confirmation
+eve verify --tool claude-code
+```
+
+### Codex OAuth flow
+
+```bash
+eve auth login --tool codex-cli --auth-mode oauth
+eve install --tool codex-cli --auth-mode oauth --apply --yes
+eve verify --tool codex-cli --auth-mode oauth
+```
+
+### Memory commands
+
+```bash
+eve memory search "what database do we use" --context naya
+eve memory search "auth patterns" --limit 5 --json
+eve memory status
+eve memory status --json
+```
+
+### Common commands
+
+```bash
+eve quickstart
+eve connect
+eve install --dry-run
+eve install --apply --yes --tool claude-code
+eve status
+eve doctor
+eve verify
+eve repair --tool gemini-cli --apply --yes
+eve uninstall --tool claude-code --yes
+eve run --tool codex-cli -- exec "Use Eve memory to search for my latest preference."
+```
+
+## Manual MCP Configuration
+
+If you do not want the installer to edit client config for you, add the hosted Eve MCP server manually.
+
+### Shared hosted MCP endpoint
+
+```text
+https://mcp.evemem.com/mcp
+```
+
+### Claude Code / Gemini CLI (API key)
+
+Use a tenant API key from the Eve admin panel.
+
+```json
+{
+  "eve-memory": {
+    "type": "http",
+    "url": "https://mcp.evemem.com/mcp",
+    "headers": {
+      "X-API-Key": "eve_<tenant>_...",
+      "X-Source-Agent": "claude_code"
+    }
+  }
+}
+```
+
+For Gemini, keep the same shape and change:
+
+```text
+X-Source-Agent = gemini_cli
+```
+
+### Codex CLI (OAuth)
+
+Codex should use an Eve-owned bearer token, not native `codex mcp login`.
+
+```toml
+[mcp_servers.eve-memory]
+url = "https://mcp.evemem.com/mcp"
+bearer_token_env_var = "EVE_CODEX_BEARER_TOKEN"
+startup_timeout_sec = 60
+
+[mcp_servers.eve-memory.headers]
+X-Source-Agent = "codex_cli"
+```
+
+OAuth resource:
+
+```text
+https://mcp.evemem.com/mcp
+```
+
+Codex prompt seeding belongs in the active project `AGENTS.md`. Eve manages its
+own marked block inside that file rather than creating a parallel sidecar file.
+
+### Other MCP clients
+
+For other remote MCP clients, the minimum working setup is:
+
+1. MCP URL:
+
+```text
+https://mcp.evemem.com/mcp
+```
+
+2. One source-agent header:
+
+```text
+X-Source-Agent: your_client_name
+```
+
+3. Choose one auth style:
+
+- API key:
+
+```text
+X-API-Key: eve_<tenant>_...
+```
+
+- OAuth bearer:
+
+```text
+Authorization: Bearer <token>
+```
+
+4. For OAuth-capable clients, use this resource identifier:
+
+```text
+https://mcp.evemem.com/mcp
+```
+
+5. Required scopes:
+
+```text
+memory.read
+memory.write
+```
+
+If the client supports a companion instruction file, point it at the active
+instruction file for that tool rather than inventing a second parallel file.
+
+### Which auth path to use
+
+- Claude Code: API key
+- Gemini CLI: API key
+- Codex CLI: Eve OAuth
+
+If you want Eve to manage the config, prompts, hooks, and verification for you, use `eve connect` instead of editing files manually.
+
+## Safety Model
+
+- no silent shell profile mutation
+- no undocumented hooks
+- no overwrite of user-authored instruction files
+- backup and manifest tracking before mutation
+- explicit rollback and uninstall support
+- uninstall removes Eve-managed credentials and tool entries, and warns when a user-modified Eve-owned file requires manual review
+
+## Development
+
+Run tests:
+
+```bash
+uv run pytest --cov=eve_client --cov-report=term-missing -q tests
+```
+
+Build Python artifacts:
+
+```bash
+uv build .
+```
+
+Check build artifacts:
+
+```bash
+uvx twine check dist/*
+```
+
+Build standalone release artifacts:
+
+```bash
+bash scripts/build-eve-client-release.sh
+```
+
+Release tags for the PyPI distribution use `eve-memory-client@<version>`, for
+example `eve-memory-client@0.3.0`.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).