Skip to content

Conversation

@david-mamani
Copy link
Contributor

Description

This PR introduces a comprehensive "Getting Started" guide for Python developers, fulfilling the documentation track requirements.

Note: This PR supersedes and replaces #257. Please merge this one as it contains the clean git history and full file content (+300 lines).

Content Added

  1. docs/tutorials/getting_started.md: A step-by-step tutorial covering installation (pip/uv), API key configuration, and memory lifecycle.
  2. examples/getting_started_robust.py: A production-ready example script demonstrating:
    • Secure API key handling.
    • Memory initialization (MemoryService).
    • Memory injection and natural language retrieval.
    • Robust error handling.

Tracks

  • Track H: Documentation / Getting Started Guide

Checklist

  • Documentation follows style guidelines.
  • Example script tested and functioning.
  • Fixes installation command to memu-py.

@david-mamani
Copy link
Contributor Author

⚠️ Blocked: Persistent Conflict & Hook Loop

I am unable to update this PR due to a persistent loop of merge conflicts and pre-commit hook (Ruff) interruptions.

Current Status:

  • Locally: My branch is clean (nothing to commit) and contains the full, correct files (+300 lines).
  • Remotely: GitHub still reports conflicts or 0 changes, even after I performed git reset --hard, created fresh branches, and used push --force.

I have tried manually rewriting the files and bypassing checks, but the sync issue persists. I suspect the pre-commit hooks are desyncing the state during the push.

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