clientcraft 0.1.0__tar.gz

clientcraft-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,84 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    name: CI (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup uv and Python
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run ruff check
+        run: uv run ruff check src tests
+
+      - name: Run ruff format check
+        run: uv run ruff format --check src tests
+
+      - name: Run mypy
+        run: uv run mypy src tests
+
+      - name: Run tests
+        run: uv run pytest --tb=short
+
+  integration:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    # Only run on main branch or when explicitly requested
+    if: github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'run-integration')
+    # Self-hosted httpbin avoids the flaky/503-prone public httpbin.org.
+    # Uses the canonical kennethreitz/httpbin image (same one httpbin.org runs),
+    # so response shapes match exactly (e.g. string-valued headers).
+    services:
+      httpbin:
+        image: kennethreitz/httpbin
+        ports:
+          - 8080:80
+    env:
+      HTTPBIN_BASE_URL: http://localhost:8080
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup uv and Python
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Wait for httpbin to be ready
+        run: |
+          for i in $(seq 1 30); do
+            if curl -sf "$HTTPBIN_BASE_URL/status/200" >/dev/null; then
+              echo "httpbin is ready"
+              exit 0
+            fi
+            echo "waiting for httpbin... ($i)"
+            sleep 1
+          done
+          echo "httpbin did not become ready in time"
+          exit 1
+
+      - name: Run integration tests
+        run: uv run pytest -m integration -n auto --tb=short

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

@@ -0,0 +1,56 @@
+name: Publish
+
+# Publishes to PyPI when a GitHub Release is published. The release tag (e.g.
+# v0.1.0) is the source of truth for the version: hatch-vcs derives the package
+# version from it, so no manual version bump is needed.
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          # Full history + tags are required for hatch-vcs to compute the version.
+          fetch-depth: 0
+
+      - name: Setup uv and Python
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Check distribution metadata
+        run: uvx twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Trusted Publishing (OIDC) — no API token needed. Requires a matching
+    # publisher configured on PyPI (see notes below) and the environment below.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/clientcraft
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

clientcraft-0.1.0/.gitignore

@@ -0,0 +1,56 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# uv
+.uv/
+# uv.lock
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db

clientcraft-0.1.0/LICENSE

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

clientcraft-0.1.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: clientcraft
+Version: 0.1.0
+Summary: A declarative, type-safe API client framework for Python
+Project-URL: Homepage, https://github.com/Sunbright-Technologies/clientcraft
+Project-URL: Repository, https://github.com/Sunbright-Technologies/clientcraft
+Author-email: SunBright Technologies <engineering@sunbright.tech>
+License: MIT
+License-File: LICENSE
+Keywords: api,async,client,declarative,http,pydantic,type-safe
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.0
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp>=3.9; extra == 'aiohttp'
+Provides-Extra: all
+Requires-Dist: aiohttp>=3.9; extra == 'all'
+Requires-Dist: httpx>=0.27; extra == 'all'
+Requires-Dist: requests>=2.32.5; extra == 'all'
+Requires-Dist: types-requests>=2.32.5; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: aiohttp>=3.9; extra == 'dev'
+Requires-Dist: httpx>=0.28.1; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: requests>=2.32.5; extra == 'dev'
+Requires-Dist: ruff>=0.3; extra == 'dev'
+Requires-Dist: types-requests>=2.32.5; extra == 'dev'
+Provides-Extra: httpx
+Requires-Dist: httpx>=0.27; extra == 'httpx'
+Provides-Extra: requests
+Requires-Dist: requests>=2.32.5; extra == 'requests'
+Requires-Dist: types-requests>=2.32.5; extra == 'requests'
+Description-Content-Type: text/markdown
+
+# Declarative API Client
+
+A declarative, type-safe API client framework for Python 3.12+.
+
+## Features
+
+- **Declarative endpoint definitions** using type annotations
+- **Type-safe** request and response handling with Pydantic
+- **Sync and async** client support
+- **Pluggable backends** (aiohttp, httpx, or custom)
+- **Multiple response types**: JSON, text, bytes, or no content
+
+## Installation
+
+```bash
+# Using uv
+uv add clientcraft
+
+# With aiohttp backend
+uv add "clientcraft[aiohttp]"
+
+# With all optional backends
+uv add "clientcraft[all]"
+```
+
+## Quick Start
+
+### Define your API
+
+```python
+from typing import Literal
+from pydantic import BaseModel
+from clientcraft import Get, Post, Delete
+from clientcraft.client import APIClient
+
+# Define request/response models
+class GetUserRequest(BaseModel):
+    user_id: str
+
+class User(BaseModel):
+    id: str
+    name: str
+    email: str
+
+class CreateUserRequest(BaseModel):
+    name: str
+    email: str
+
+# Define your API client declaratively
+class UserAPI(APIClient):
+    get_user: Get[GetUserRequest, User, Literal["/users/{user_id}"]]
+    create_user: Post[CreateUserRequest, User, Literal["/users"]]
+    delete_user: Delete[GetUserRequest, None, Literal["/users/{user_id}"]]
+```
+
+### Use your API
+
+```python
+from clientcraft.backends import RequestsBackend
+
+# Create client with a backend
+backend = RequestsBackend()
+client = UserAPI(base_url="https://api.example.com", backend=backend)
+
+# Make requests - fully typed!
+user = client.get_user(GetUserRequest(user_id="123"))
+print(user.name)  # Type checker knows this is a User
+
+# Create a user
+new_user = client.create_user(CreateUserRequest(name="Alice", email="alice@example.com"))
+```
+
+### Async Usage
+
+```python
+from clientcraft import AsyncGet, AsyncPost
+from clientcraft.async_client import AsyncAPIClient
+from clientcraft.backends import AiohttpBackend
+
+class AsyncUserAPI(AsyncAPIClient):
+    get_user: AsyncGet[GetUserRequest, User, Literal["/users/{user_id}"]]
+    create_user: AsyncPost[CreateUserRequest, User, Literal["/users"]]
+
+async with AiohttpBackend() as backend:
+    client = AsyncUserAPI(base_url="https://api.example.com", backend=backend)
+    user = await client.get_user(GetUserRequest(user_id="123"))
+```
+
+## Endpoint Types
+
+| Type | HTTP Method | Request Style | Description |
+|------|-------------|---------------|-------------|
+| `Get` | GET | Query params | Read operations |
+| `Post` | POST | JSON body | Create operations |
+| `Put` | PUT | JSON body | Full update |
+| `Patch` | PATCH | JSON body | Partial update |
+| `Delete` | DELETE | Query params | Delete operations |
+
+## Response Types
+
+```python
+from clientcraft import TextResponse, BytesResponse
+
+class HealthAPI(APIClient):
+    # JSON response (default)
+    get_user: Get[Request, User, Literal["/users/{id}"]]
+    
+    # Text response
+    health_check: Get[Request, TextResponse, Literal["/health"]]
+    
+    # Binary response
+    download: Get[Request, BytesResponse, Literal["/files/{id}"]]
+    
+    # No response body (204 No Content)
+    delete_user: Delete[Request, None, Literal["/users/{id}"]]
+```
+
+## Development
+
+```bash
+# Clone and setup
+cd clientcraft
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Type checking
+uv run mypy
+
+# Linting
+uv run ruff check .
+```
+
+## License
+
+MIT

clientcraft-0.1.0/README.md

@@ -0,0 +1,137 @@
+# Declarative API Client
+
+A declarative, type-safe API client framework for Python 3.12+.
+
+## Features
+
+- **Declarative endpoint definitions** using type annotations
+- **Type-safe** request and response handling with Pydantic
+- **Sync and async** client support
+- **Pluggable backends** (aiohttp, httpx, or custom)
+- **Multiple response types**: JSON, text, bytes, or no content
+
+## Installation
+
+```bash
+# Using uv
+uv add clientcraft
+
+# With aiohttp backend
+uv add "clientcraft[aiohttp]"
+
+# With all optional backends
+uv add "clientcraft[all]"
+```
+
+## Quick Start
+
+### Define your API
+
+```python
+from typing import Literal
+from pydantic import BaseModel
+from clientcraft import Get, Post, Delete
+from clientcraft.client import APIClient
+
+# Define request/response models
+class GetUserRequest(BaseModel):
+    user_id: str
+
+class User(BaseModel):
+    id: str
+    name: str
+    email: str
+
+class CreateUserRequest(BaseModel):
+    name: str
+    email: str
+
+# Define your API client declaratively
+class UserAPI(APIClient):
+    get_user: Get[GetUserRequest, User, Literal["/users/{user_id}"]]
+    create_user: Post[CreateUserRequest, User, Literal["/users"]]
+    delete_user: Delete[GetUserRequest, None, Literal["/users/{user_id}"]]
+```
+
+### Use your API
+
+```python
+from clientcraft.backends import RequestsBackend
+
+# Create client with a backend
+backend = RequestsBackend()
+client = UserAPI(base_url="https://api.example.com", backend=backend)
+
+# Make requests - fully typed!
+user = client.get_user(GetUserRequest(user_id="123"))
+print(user.name)  # Type checker knows this is a User
+
+# Create a user
+new_user = client.create_user(CreateUserRequest(name="Alice", email="alice@example.com"))
+```
+
+### Async Usage
+
+```python
+from clientcraft import AsyncGet, AsyncPost
+from clientcraft.async_client import AsyncAPIClient
+from clientcraft.backends import AiohttpBackend
+
+class AsyncUserAPI(AsyncAPIClient):
+    get_user: AsyncGet[GetUserRequest, User, Literal["/users/{user_id}"]]
+    create_user: AsyncPost[CreateUserRequest, User, Literal["/users"]]
+
+async with AiohttpBackend() as backend:
+    client = AsyncUserAPI(base_url="https://api.example.com", backend=backend)
+    user = await client.get_user(GetUserRequest(user_id="123"))
+```
+
+## Endpoint Types
+
+| Type | HTTP Method | Request Style | Description |
+|------|-------------|---------------|-------------|
+| `Get` | GET | Query params | Read operations |
+| `Post` | POST | JSON body | Create operations |
+| `Put` | PUT | JSON body | Full update |
+| `Patch` | PATCH | JSON body | Partial update |
+| `Delete` | DELETE | Query params | Delete operations |
+
+## Response Types
+
+```python
+from clientcraft import TextResponse, BytesResponse
+
+class HealthAPI(APIClient):
+    # JSON response (default)
+    get_user: Get[Request, User, Literal["/users/{id}"]]
+    
+    # Text response
+    health_check: Get[Request, TextResponse, Literal["/health"]]
+    
+    # Binary response
+    download: Get[Request, BytesResponse, Literal["/files/{id}"]]
+    
+    # No response body (204 No Content)
+    delete_user: Delete[Request, None, Literal["/users/{id}"]]
+```
+
+## Development
+
+```bash
+# Clone and setup
+cd clientcraft
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Type checking
+uv run mypy
+
+# Linting
+uv run ruff check .
+```
+
+## License
+
+MIT