feat: add API client and CLI for bookshelf-platform integration #125
Conversation
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
Add comprehensive support for the new bookshelf-platform API: - API client module (bookshelf.api): - BookshelfAPIClient for volumes, books, and authentication - Pydantic schemas for request/response validation - Custom error types (APIError, AuthenticationError, NotFoundError, ServerError) - Authentication module (bookshelf.auth): - Credential storage using platformdirs - Token expiry management - Environment variable overrides (BOOKSHELF_API_URL, BOOKSHELF_TOKEN) - CLI tool (bookshelf-client): - auth commands: login, logout, status - volumes commands: list, show - books commands: list, show - Rich terminal output with tables and panels - 76 unit tests covering all new functionality Dependencies added: httpx, click, rich, respx (dev)
Remove authentication requirement from volumes and books CLI commands to allow unauthenticated access to public datasets. Auth is still available and will be used if credentials exist. Also fix uv deprecation warning by migrating from tool.uv.dev-dependencies to dependency-groups.dev in all pyproject.toml files.
- Set default API URL to https://api.staging.climateresource.com.au/bookshelf/v1 - Remove /api prefix from endpoint paths (base URL includes full path) - Update all tests to match new URL structure
Migrate CLI authentication from username/password (POST /auth/token) to WorkOS OAuth with PKCE and Device Code flows. The old endpoint no longer exists after the platform migrated to WorkOS. - Add oauth.py with PKCE, Device Code, and token refresh flows - Extend Credentials with refresh_token, add auto-refresh on expiry - Replace login command: --device-code flag for headless environments - Add on_token_refresh callback to API client with 401 retry - Add refresh_token to TokenResponse schema
WorkOS requires a connection selector (connection_id, organization_id, or provider) in the authorize request. Without it, the flow fails with invalid_connection_selector.
lewisjared
force-pushed
the
feature/api-support
branch
from
a3690a6 to
bfff8e8
Compare
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
BookshelfAPIClientHTTP client for the bookshelf-platform backend API with auth, error handling, and typed response schemasbookshelf.authmodule for token-based authentication (device flow, token storage/refresh)bookshelf-client/bsc) withauth,books, andvolumessubcommands using Click + RichDetails
This is a feature branch that will accumulate further PRs. The initial set of changes introduces:
bookshelf.api): Synchronous httpx-based client with Pydantic response models for volumes, books, and tokensbookshelf.auth): Device code flow authentication, secure token storage via platformdirs, automatic token refreshbookshelf.cli): Click-based CLI with commands for login/logout/status, listing/searching books and volumesTest plan
uv run --package bookshelf pytest packages/bookshelf/tests/unit/test_api_client.pyuv run --package bookshelf pytest packages/bookshelf/tests/unit/test_auth.pyuv run --package bookshelf pytest packages/bookshelf/tests/unit/test_cli.py