docs: update ember-client readme, add crates index, regenerate protos - #307
Merged
Conversation
- ember-client readme now covers all 65+ commands (strings, keys, lists, hashes, sets, sorted sets, server, slowlog, pub/sub, vector), public types (ScanPage, SlowlogEntry, Message, SimResult), and the full pipeline method reference - new crates/README.md: crate table with package names, dependency graph, cargo cheat-sheet, and makefile target reference - regenerate go and python grpc stubs from the latest proto (closes api gap from pr #306 — 39 new rpcs now reflected in generated code) - fix clients/ember-py/Makefile: use python3 instead of python
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
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
documentation catch-up for the gRPC API gap (pr #306) and client growth:
ScanPage,SlowlogEntry,Message,SimResult), the full pipeline method reference, and the vector feature sectionember-core→emberkv-corepackage name note that trips people up), ascii dependency graph, cargo cheat-sheet, and makefile target reference including the proto-gen targetspython→python3for compatibility on systems where onlypython3is in$PATHwhat was tested
make proto-go— generatedclients/ember-go/proto/ember/v1/ember.pb.goandember_grpc.pb.gocleanlymake proto-py— generatedclients/ember-py/ember/proto/ember/v1/ember_pb2.pyandember_pb2_grpc.pycleanly, import fix applied by sedcargo build -p ember-clientpasses (no code changes)commands.rs,pipeline.rs, andvector.rssource