Skip to content

docs: fix Python package name in getting started#155

Merged
nullure merged 1 commit intoCaviraOSS:mainfrom
suyua9:docs/fix-python-install-name-suyua9
Apr 4, 2026
Merged

docs: fix Python package name in getting started#155
nullure merged 1 commit intoCaviraOSS:mainfrom
suyua9:docs/fix-python-install-name-suyua9

Conversation

@suyua9
Copy link
Copy Markdown
Contributor

@suyua9 suyua9 commented Apr 3, 2026

📋 Description

  • fix the Python install command in docs/getting-started.md
  • align the getting-started guide with the published package metadata and the other README files, which already use openmemory-py

🔄 Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🎨 Style/UI changes
  • ♻️ Code refactoring
  • ⚡ Performance improvements
  • 🧪 Test updates
  • 🔧 Build/CI changes

🧪 Testing

  • I have tested this change locally
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Validated by:

  • checking packages/openmemory-py/pyproject.toml (name = "openmemory-py")
  • verifying the remaining install snippets in README.md and packages/openmemory-py/README.md already use openmemory-py

📱 Screenshots (if applicable)

  • not applicable

🔍 Code Review Checklist

  • Code follows the project's coding standards
  • Self-review of the code has been performed
  • Code is properly commented, particularly in hard-to-understand areas
  • Changes generate no new warnings
  • Any dependent changes have been merged and published

📚 Related Issues

  • none

🚀 Deployment Notes

  • none; docs-only change

📋 Additional Context

  • this avoids sending Python users to the unrelated openmemory package when following the getting-started guide

Copy link
Copy Markdown
Member

@nullure nullure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nullure nullure merged commit ca3a711 into CaviraOSS:main Apr 4, 2026
3 checks passed
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.

2 participants