Add CLI and API usage documentation to README#66
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #66 +/- ##
=======================================
Coverage 70.42% 70.42%
=======================================
Files 9 9
Lines 886 886
=======================================
Hits 624 624
Misses 262 262 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive CLI and API usage documentation to the README, making it easier for users to interact with the Sample Registry without needing to inspect source code.
Changes:
- Added a CLI usage section documenting all 11 installed command-line tools with examples showing typical workflows for run/sample/annotation management
- Added an API usage section documenting the 7 available
POST /api/*endpoints with examplecurlrequests and expected JSON responses - Fixed a minor grammar issue ("libraries utilities" → "library utilities")
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Motivation
Description
README.mdwith a new CLI usage section listing the installed commands (e.g.register_run,register_samples,modify_run, etc.) and showing how to use-hfor help.SAMPLE_REGISTRY_DB_URI(defaulting to a local SQLite file when unset).POST /api/*endpoints, examplecurlrequests forregister_run,modify_run, andmodify_sample, and the expected JSON success/error responses.register_samples/register_annotationsby specifying thesample_tableJSON key ormultipart/form-datafile upload.Testing
pytest -qin the environment, which failed during test collection due to a missing dependency:ModuleNotFoundError: No module named 'flask_sqlalchemy'.Codex Task