docs/refactor: improve read API, fix setup.py, add type hints and comprehensive docs - #357
Open
jimmyliuzg wants to merge 1 commit into
Open
docs/refactor: improve read API, fix setup.py, add type hints and comprehensive docs#357jimmyliuzg wants to merge 1 commit into
jimmyliuzg wants to merge 1 commit into
Conversation
- Add comprehensive README.md with examples, method tables, and field reference for all export tables - Add type hints (str) to CellarTracker and CellarTrackerClient init - Add detailed docstrings to all public methods with field descriptions - Fix setup.py: trailing comma after requirements list was creating a tuple instead of a list, breaking pip install - Add --json and --list-tables flags to CLI - Add TABLE_DESCRIPTIONS with human-readable table names - Raise minimum Python version from 3.5 to 3.9 (f-string usage)
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
Improves the read-only CellarTracker API with better documentation, type safety, and bug fixes. No breaking changes — all existing interfaces are preserved.
Changes
Bug Fix
Documentation
Type Safety
CLI Improvements
Compatibility