Skip to content

Comments

Add CLI and API usage documentation to README#66

Merged
Ulthran merged 2 commits intomasterfrom
codex/add-cli-and-api-usage-documentation
Feb 5, 2026
Merged

Add CLI and API usage documentation to README#66
Ulthran merged 2 commits intomasterfrom
codex/add-cli-and-api-usage-documentation

Conversation

@Ulthran
Copy link
Contributor

@Ulthran Ulthran commented Feb 5, 2026

Motivation

  • Provide clear, discoverable documentation for the installed CLI tools and the JSON API so users can operate the registry without inspecting source code.
  • Clarify how commands interact with the configured database and document typical workflows for run/sample/annotation management.

Description

  • Extended README.md with a new CLI usage section listing the installed commands (e.g. register_run, register_samples, modify_run, etc.) and showing how to use -h for help.
  • Added examples showing common command-line workflows and clarified that commands use the database configured by SAMPLE_REGISTRY_DB_URI (defaulting to a local SQLite file when unset).
  • Added an API usage section documenting available POST /api/* endpoints, example curl requests for register_run, modify_run, and modify_sample, and the expected JSON success/error responses.
  • Clarified metadata-table payload handling for register_samples/register_annotations by specifying the sample_table JSON key or multipart/form-data file upload.

Testing

  • Ran pytest -q in the environment, which failed during test collection due to a missing dependency: ModuleNotFoundError: No module named 'flask_sqlalchemy'.
  • No additional automated tests were added or executed for the documentation-only change.

Codex Task

Copilot AI review requested due to automatic review settings February 5, 2026 15:34
@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.42%. Comparing base (e0be84e) to head (403686f).
⚠️ Report is 3 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 example curl requests 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.

@Ulthran Ulthran merged commit b38a2b3 into master Feb 5, 2026
6 of 7 checks passed
@Ulthran Ulthran deleted the codex/add-cli-and-api-usage-documentation branch February 5, 2026 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant