Improve README and CONTRIBUTING documentation#25
Merged
merlimat merged 1 commit intooxia-db:mainfrom Apr 16, 2026
Merged
Conversation
README.md: - Fix h2/h1 tag mismatch - Add install instructions, quick-start code snippet, feature list - Fix badge to point to the Python client repo - Add Python version requirement - Remove broken empty [guide]() link - Rewrite subtitle to describe the client, not Oxia itself CONTRIBUTING.md: - Replace "golang project" with Python-specific instructions - Replace make test/lint with uv run pytest - Fix clone URL from oxia to oxia-client-python - Add development setup section (uv, Docker, proto regen) - Document DCO sign-off requirement __init__.py: - Fix usage example: remove oxia:// scheme prefix, use context manager, use bytes value Signed-off-by: Matteo Merli <mmerli@apache.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.md — rewritten:
pip install oxia)[guide]()linkCONTRIBUTING.md — rewritten for Python:
make test/make lintwithuv run pytestoxiatooxia-client-python__init__.py— fixed usage example:oxia://scheme prefix (not used by the client)bytesliteral