Add simplified SDK client API and comprehensive documentation

- Create DeltaGliderClient with user-friendly interface
- Add create_client() factory function with sensible defaults
- Implement UploadSummary dataclass with helpful properties
- Expose simplified API through main package
- Add comprehensive SDK documentation under docs/sdk/:
  - Getting started guide with installation and examples
  - Complete API reference documentation
  - Real-world usage examples for 8 common scenarios
  - Architecture deep dive explaining how DeltaGlider works
  - Automatic documentation generation scripts
- Update CONTRIBUTING.md with SDK documentation guidelines
- All tests pass and code quality checks succeed

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Simone Scarduzio
2025-09-23 13:44:38 +02:00
parent f08960b6c5
commit edcbd2c7d0
10 changed files with 3136 additions and 1 deletions

View File

@@ -102,11 +102,27 @@ uv run pytest -m e2e
- Use type hints for all function signatures
- Write docstrings for all public functions and classes
## Documentation
### SDK Documentation
The SDK documentation is located in `docs/sdk/` and includes:
- Getting Started guide
- API Reference
- Examples and use cases
- Architecture overview
When making changes to the Python SDK:
1. Update relevant documentation in `docs/sdk/`
2. Update docstrings in the code
3. Run `make generate` in `docs/sdk/` to update auto-generated docs
## Pull Request Process
1. Update the README.md with details of changes to the interface, if applicable
2. Update the docs/ with any new functionality
3. The PR will be merged once you have the sign-off of at least one maintainer
3. Update SDK documentation if you've modified the client API
4. The PR will be merged once you have the sign-off of at least one maintainer
## Performance Considerations