teachworks-sdk 0.2.1__tar.gz

teachworks_sdk-0.2.1/.gitignore

@@ -0,0 +1,30 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Local development
+.env
+.env.local

teachworks_sdk-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Teachworks SDK Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

teachworks_sdk-0.2.1/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: teachworks-sdk
+Version: 0.2.1
+Summary: Python SDK for the Teachworks API.
+Project-URL: Homepage, https://github.com/north-star-tutors/Teachworks-SDK
+Project-URL: Repository, https://github.com/north-star-tutors/Teachworks-SDK
+Project-URL: Documentation, https://github.com/north-star-tutors/Teachworks-SDK#readme
+Author: Teachworks SDK Contributors
+License: MIT License
+        
+        Copyright (c) 2024 Teachworks SDK Contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: api,sdk,teachworks
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.6.0
+Requires-Dist: requests>=2.31.0
+Description-Content-Type: text/markdown
+
+# Teachworks SDK
+
+A Python SDK for the [Teachworks API](https://documenter.getpostman.com/view/10096149/SWTABydD). This package provides a typed, validated, and well-organized interface to Teachworks, built around a resilient `TeachworksSession` that manages authentication, rate limits, pagination, and error handling.
+
+## Installation
+
+```bash
+pip install teachworks-sdk
+```
+
+## Quick Start
+
+```python
+from teachworks_sdk import TeachworksSession
+
+with TeachworksSession(api_key="your-api-key") as session:
+    # List all locations
+    locations = session.locations.list()
+    for location in locations:
+        print(location.id, location.name)
+
+    # Fetch all students across pages
+    students = session.students.list(all_pages=True)
+
+    # Retrieve a single record
+    employee = session.employees.retrieve(123)
+```
+
+## Features
+
+- **23 API resources** - Customers, students, employees, lessons, invoices, payments, and more
+- **Automatic pagination** - Fetch all pages with `all_pages=True`
+- **Rate limiting** - Built-in request throttling and retry with exponential backoff
+- **Typed responses** - Pydantic models with full type hints
+- **Relationship resolution** - Lazy-load related resources
+- **Session caching** - Identity map prevents duplicate fetches
+- **Comprehensive logging** - DEBUG, INFO, WARNING, and ERROR logging with flexible configuration
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Usage Guide](docs/usage.md) | Configuration, error handling, caching, filtering patterns |
+| [Logging Guide](docs/LOGGING.md) | Comprehensive logging configuration and troubleshooting |
+| [API Reference](docs/api-reference.md) | Complete list of resources and methods |
+| [Types Reference](docs/types.md) | All model types and their properties |
+
+## Basic Examples
+
+### Error Handling
+
+```python
+from teachworks_sdk import TeachworksSession, TeachworksAPIError
+
+try:
+    location = session.locations.retrieve(999999)
+except TeachworksAPIError as exc:
+    print(exc.status_code, exc.message)
+```
+
+### Typed Filtering
+
+```python
+from teachworks_sdk import TeachworksSession, Types
+from datetime import date
+
+lessons = session.lessons.list(
+    query=Types.LessonListParams(
+        employee_id=42,
+        from_date=date(2024, 1, 1)
+    )
+)
+```
+
+### Relationship Resolution
+
+```python
+participant = session.lesson_participants.retrieve(42)
+student = participant.resolve(session).student()
+```
+
+### Logging
+
+```python
+import logging
+
+# Enable SDK logging with your app's configuration
+logging.basicConfig(level=logging.INFO)
+
+# Or enable DEBUG logging for SDK only
+logging.getLogger("teachworks").setLevel(logging.DEBUG)
+
+# See the Logging Guide for advanced configuration
+```
+
+## Development
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+## License
+
+MIT

teachworks_sdk-0.2.1/README.md

@@ -0,0 +1,106 @@
+# Teachworks SDK
+
+A Python SDK for the [Teachworks API](https://documenter.getpostman.com/view/10096149/SWTABydD). This package provides a typed, validated, and well-organized interface to Teachworks, built around a resilient `TeachworksSession` that manages authentication, rate limits, pagination, and error handling.
+
+## Installation
+
+```bash
+pip install teachworks-sdk
+```
+
+## Quick Start
+
+```python
+from teachworks_sdk import TeachworksSession
+
+with TeachworksSession(api_key="your-api-key") as session:
+    # List all locations
+    locations = session.locations.list()
+    for location in locations:
+        print(location.id, location.name)
+
+    # Fetch all students across pages
+    students = session.students.list(all_pages=True)
+
+    # Retrieve a single record
+    employee = session.employees.retrieve(123)
+```
+
+## Features
+
+- **23 API resources** - Customers, students, employees, lessons, invoices, payments, and more
+- **Automatic pagination** - Fetch all pages with `all_pages=True`
+- **Rate limiting** - Built-in request throttling and retry with exponential backoff
+- **Typed responses** - Pydantic models with full type hints
+- **Relationship resolution** - Lazy-load related resources
+- **Session caching** - Identity map prevents duplicate fetches
+- **Comprehensive logging** - DEBUG, INFO, WARNING, and ERROR logging with flexible configuration
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Usage Guide](docs/usage.md) | Configuration, error handling, caching, filtering patterns |
+| [Logging Guide](docs/LOGGING.md) | Comprehensive logging configuration and troubleshooting |
+| [API Reference](docs/api-reference.md) | Complete list of resources and methods |
+| [Types Reference](docs/types.md) | All model types and their properties |
+
+## Basic Examples
+
+### Error Handling
+
+```python
+from teachworks_sdk import TeachworksSession, TeachworksAPIError
+
+try:
+    location = session.locations.retrieve(999999)
+except TeachworksAPIError as exc:
+    print(exc.status_code, exc.message)
+```
+
+### Typed Filtering
+
+```python
+from teachworks_sdk import TeachworksSession, Types
+from datetime import date
+
+lessons = session.lessons.list(
+    query=Types.LessonListParams(
+        employee_id=42,
+        from_date=date(2024, 1, 1)
+    )
+)
+```
+
+### Relationship Resolution
+
+```python
+participant = session.lesson_participants.retrieve(42)
+student = participant.resolve(session).student()
+```
+
+### Logging
+
+```python
+import logging
+
+# Enable SDK logging with your app's configuration
+logging.basicConfig(level=logging.INFO)
+
+# Or enable DEBUG logging for SDK only
+logging.getLogger("teachworks").setLevel(logging.DEBUG)
+
+# See the Logging Guide for advanced configuration
+```
+
+## Development
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+## License
+
+MIT