python-zendesk-sdk 0.1.0__tar.gz

python_zendesk_sdk-0.1.0/.flake8

@@ -0,0 +1,23 @@
+[flake8]
+max-line-length = 120
+extend-ignore =
+    # E203: whitespace before ':'
+    E203,
+    # W503: line break before binary operator
+    W503,
+    # E501: line too long (handled by black)
+    E501
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    venv,
+    build,
+    dist,
+    *.egg-info,
+    .pytest_cache,
+    .mypy_cache,
+    proto/
+per-file-ignores =
+    __init__.py:F401
+max-complexity = 10

python_zendesk_sdk-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

python_zendesk_sdk-0.1.0/.gitignore

@@ -0,0 +1,192 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to ignore the entire idea/ directory.
+.idea/
+
+# VS Code
+.vscode/
+
+# pyenv - keep .python-version in git for consistent development environment
+# (already handled in pyenv section above)
+
+# UV - not used in this project
+.uv/
+uv.lock
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temporary files
+*.tmp
+*.temp
+*.swp
+*.swo
+*~
+
+# Debug files
+debug.py
+
+# Local directories
+.claude/
+llm/

python_zendesk_sdk-0.1.0/.python-version

@@ -0,0 +1 @@
+python-zendesk-sdk

python_zendesk_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bormog
+
+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.

python_zendesk_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: python-zendesk-sdk
+Version: 0.1.0
+Summary: Modern Python SDK for Zendesk API
+Project-URL: Homepage, https://github.com/bormog/python-zendesk-sdk
+Project-URL: Repository, https://github.com/bormog/python-zendesk-sdk
+Project-URL: Issues, https://github.com/bormog/python-zendesk-sdk/issues
+Author: bormog
+License: MIT
+License-File: LICENSE
+Keywords: api,client,sdk,zendesk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8.1
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: flake8>=6.0.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Python Zendesk SDK
+
+Modern Python SDK for Zendesk API with async support, full type safety, and comprehensive error handling.
+
+## Status: Ready for Read-Only Operations ✅
+
+This project has completed iterations 1-4 and is ready for production use in read-only mode.
+
+### Completed Features ✅
+
+- **Project Infrastructure**: Complete setup with `pyproject.toml`, dependencies, and linting
+- **Configuration System**: `ZendeskConfig` with environment variable support and validation
+- **Exception Handling**: Comprehensive exception hierarchy for different error types
+- **HTTP Client**: Async HTTP client with retry logic, rate limiting, and exponential backoff
+- **Pagination**: Both offset-based and cursor-based pagination support
+- **Data Models**: Full Pydantic v2 models for Users, Organizations, Tickets, and Comments
+- **Read API Methods**: 13 methods for reading data from Zendesk
+  - Users: `get_users()`, `get_user()`, `get_user_by_email()`
+  - Organizations: `get_organizations()`, `get_organization()`
+  - Tickets: `get_tickets()`, `get_ticket()`, `get_user_tickets()`, `get_organization_tickets()`
+  - Comments: `get_ticket_comments()`
+  - Search: `search()`, `search_users()`, `search_tickets()`, `search_organizations()`
+- **Testing Framework**: Full test suite with 128+ passing tests
+- **Code Quality**: Black, isort, flake8, and mypy configured
+
+### In Development 🚧
+
+- Write operations (create/update/delete) - planned for future iteration
+- Documentation & Examples (Iteration 5)
+
+## Installation
+
+```bash
+# Install from PyPI (when published)
+pip install python-zendesk-sdk
+
+# Or install from source
+git clone <repository-url>
+cd python-zendesk-sdk
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+from zendesk_sdk import ZendeskClient, ZendeskConfig
+
+async def main():
+    # Create configuration
+    config = ZendeskConfig(
+        subdomain="your-subdomain",
+        email="your-email@example.com",
+        token="your-api-token",  # or use password="your-password"
+    )
+
+    # Use async context manager
+    async with ZendeskClient(config) as client:
+        # Get users with pagination
+        users_paginator = await client.get_users(per_page=10)
+        users = await users_paginator.get_page()
+
+        for user in users:
+            print(f"User: {user.name} ({user.email})")
+
+        # Get specific ticket
+        ticket = await client.get_ticket(ticket_id=12345)
+        print(f"Ticket: {ticket.subject}")
+
+        # Search tickets
+        results = await client.search_tickets("status:open priority:high")
+        for ticket in results:
+            print(f"High priority: {ticket.subject}")
+
+asyncio.run(main())
+```
+
+## Configuration
+
+The SDK supports multiple ways to configure authentication:
+
+### 1. Direct instantiation
+```python
+config = ZendeskConfig(
+    subdomain="mycompany",
+    email="user@example.com",
+    token="api_token_here"
+)
+```
+
+### 2. Environment variables
+```bash
+export ZENDESK_SUBDOMAIN=mycompany
+export ZENDESK_EMAIL=user@example.com
+export ZENDESK_TOKEN=api_token_here
+```
+
+```python
+config = ZendeskConfig()  # Will load from environment
+```
+
+### 3. Mixed approach
+```python
+# Override specific values, rest from environment
+config = ZendeskConfig(subdomain="different-subdomain")
+```
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=src/zendesk_sdk --cov-report=html
+
+# Run specific test file
+pytest tests/test_config.py -v
+```
+
+### Code Quality
+
+```bash
+# Format code
+python -m black src tests
+python -m isort src tests
+
+# Lint code
+python -m flake8 src tests
+
+# Type checking
+python -m mypy src
+```
+
+### Running All Checks
+
+```bash
+# Format, lint, and test
+python -m black src tests && python -m isort src tests && python -m flake8 src tests && python -m mypy src && pytest
+```
+
+## Project Structure
+
+```
+├── src/zendesk_sdk/          # Main package
+│   ├── __init__.py           # Public API exports
+│   ├── client.py             # Main ZendeskClient class
+│   ├── config.py             # Configuration management
+│   ├── exceptions.py         # Exception hierarchy
+│   └── models/               # Data models
+│       ├── __init__.py
+│       └── base.py           # Base model class
+├── tests/                    # Test suite
+├── pyproject.toml            # Project configuration
+└── README.md                 # This file
+```
+
+## Requirements
+
+- Python 3.8+
+- httpx (for async HTTP client)
+- pydantic >=2.0 (for data validation)
+
+## Development Roadmap
+
+- [x] **Iteration 1**: Infrastructure Setup
+- [x] **Iteration 2**: HTTP Client & Pagination
+- [x] **Iteration 3**: Data Models (Users, Tickets, Organizations, Comments)
+- [x] **Iteration 4**: Read-Only API Methods & Search
+- [ ] **Iteration 5**: Documentation & Examples (in progress)
+- [ ] **Future**: Write operations (create/update/delete)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+This project is currently in early development. Contribution guidelines will be added in future iterations.

python_zendesk_sdk-0.1.0/README.md

@@ -0,0 +1,181 @@
+# Python Zendesk SDK
+
+Modern Python SDK for Zendesk API with async support, full type safety, and comprehensive error handling.
+
+## Status: Ready for Read-Only Operations ✅
+
+This project has completed iterations 1-4 and is ready for production use in read-only mode.
+
+### Completed Features ✅
+
+- **Project Infrastructure**: Complete setup with `pyproject.toml`, dependencies, and linting
+- **Configuration System**: `ZendeskConfig` with environment variable support and validation
+- **Exception Handling**: Comprehensive exception hierarchy for different error types
+- **HTTP Client**: Async HTTP client with retry logic, rate limiting, and exponential backoff
+- **Pagination**: Both offset-based and cursor-based pagination support
+- **Data Models**: Full Pydantic v2 models for Users, Organizations, Tickets, and Comments
+- **Read API Methods**: 13 methods for reading data from Zendesk
+  - Users: `get_users()`, `get_user()`, `get_user_by_email()`
+  - Organizations: `get_organizations()`, `get_organization()`
+  - Tickets: `get_tickets()`, `get_ticket()`, `get_user_tickets()`, `get_organization_tickets()`
+  - Comments: `get_ticket_comments()`
+  - Search: `search()`, `search_users()`, `search_tickets()`, `search_organizations()`
+- **Testing Framework**: Full test suite with 128+ passing tests
+- **Code Quality**: Black, isort, flake8, and mypy configured
+
+### In Development 🚧
+
+- Write operations (create/update/delete) - planned for future iteration
+- Documentation & Examples (Iteration 5)
+
+## Installation
+
+```bash
+# Install from PyPI (when published)
+pip install python-zendesk-sdk
+
+# Or install from source
+git clone <repository-url>
+cd python-zendesk-sdk
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+from zendesk_sdk import ZendeskClient, ZendeskConfig
+
+async def main():
+    # Create configuration
+    config = ZendeskConfig(
+        subdomain="your-subdomain",
+        email="your-email@example.com",
+        token="your-api-token",  # or use password="your-password"
+    )
+
+    # Use async context manager
+    async with ZendeskClient(config) as client:
+        # Get users with pagination
+        users_paginator = await client.get_users(per_page=10)
+        users = await users_paginator.get_page()
+
+        for user in users:
+            print(f"User: {user.name} ({user.email})")
+
+        # Get specific ticket
+        ticket = await client.get_ticket(ticket_id=12345)
+        print(f"Ticket: {ticket.subject}")
+
+        # Search tickets
+        results = await client.search_tickets("status:open priority:high")
+        for ticket in results:
+            print(f"High priority: {ticket.subject}")
+
+asyncio.run(main())
+```
+
+## Configuration
+
+The SDK supports multiple ways to configure authentication:
+
+### 1. Direct instantiation
+```python
+config = ZendeskConfig(
+    subdomain="mycompany",
+    email="user@example.com",
+    token="api_token_here"
+)
+```
+
+### 2. Environment variables
+```bash
+export ZENDESK_SUBDOMAIN=mycompany
+export ZENDESK_EMAIL=user@example.com
+export ZENDESK_TOKEN=api_token_here
+```
+
+```python
+config = ZendeskConfig()  # Will load from environment
+```
+
+### 3. Mixed approach
+```python
+# Override specific values, rest from environment
+config = ZendeskConfig(subdomain="different-subdomain")
+```
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=src/zendesk_sdk --cov-report=html
+
+# Run specific test file
+pytest tests/test_config.py -v
+```
+
+### Code Quality
+
+```bash
+# Format code
+python -m black src tests
+python -m isort src tests
+
+# Lint code
+python -m flake8 src tests
+
+# Type checking
+python -m mypy src
+```
+
+### Running All Checks
+
+```bash
+# Format, lint, and test
+python -m black src tests && python -m isort src tests && python -m flake8 src tests && python -m mypy src && pytest
+```
+
+## Project Structure
+
+```
+├── src/zendesk_sdk/          # Main package
+│   ├── __init__.py           # Public API exports
+│   ├── client.py             # Main ZendeskClient class
+│   ├── config.py             # Configuration management
+│   ├── exceptions.py         # Exception hierarchy
+│   └── models/               # Data models
+│       ├── __init__.py
+│       └── base.py           # Base model class
+├── tests/                    # Test suite
+├── pyproject.toml            # Project configuration
+└── README.md                 # This file
+```
+
+## Requirements
+
+- Python 3.8+
+- httpx (for async HTTP client)
+- pydantic >=2.0 (for data validation)
+
+## Development Roadmap
+
+- [x] **Iteration 1**: Infrastructure Setup
+- [x] **Iteration 2**: HTTP Client & Pagination
+- [x] **Iteration 3**: Data Models (Users, Tickets, Organizations, Comments)
+- [x] **Iteration 4**: Read-Only API Methods & Search
+- [ ] **Iteration 5**: Documentation & Examples (in progress)
+- [ ] **Future**: Write operations (create/update/delete)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+This project is currently in early development. Contribution guidelines will be added in future iterations.