integrates 0.1.0

A requests-style SDK for APIs

Integrates - A requests-style SDK for APIs

Integrates is a Python library providing a simple, ergonomic interface for interacting with various API protocols (REST, GraphQL, SOAP) while maintaining the familiar feel of the Python 'requests' library.

Features

• Simple, Pythonic API: Easy to use with sensible defaults, inspired by the popular requests library
• Protocol Adapters: Support for multiple API protocols with a consistent interface
• Authentication: Built-in support for common authentication methods (Basic, Bearer, API Key, OAuth2)
• Middleware: Extensible middleware system for customizing request/response processing
• Sync and Async Support: Use the same API for both synchronous and asynchronous code
• Strong Typing: Full type annotations for better IDE support and static analysis
• Resilient by Default: Strict timeouts, connection verification, and error handling

Installation

pip install integrates

Quick Start

Basic Usage

import integrates as api

# Create a client
client = api.Client()

# Make a GET request
response = client.get("https://api.example.com/users", params={"page": 1})
print(response.json())

# Make a POST request with JSON data
response = client.post(
    "https://api.example.com/users",
    json={"name": "John Doe", "email": "[e-mail]"}
)
print(f"Status: {response.status_code}")

Async Support

import asyncio
import integrates as api

async def main():
    async with api.AsyncClient() as client:
        response = await client.get("https://api.example.com/users")
        print(response.json())

asyncio.run(main())

Authentication

import integrates as api
from integrates.auth import BearerAuth

# Create a client with token authentication
client = api.Client(
    base_url="https://api.example.com",
    auth=BearerAuth(token="your_access_token")
)

# All requests will include the Authorization header
response = client.get("/users/me")

Middleware

import integrates as api
from integrates.middleware import RetryMiddleware, LoggingMiddleware

# Create a client with middleware
client = api.Client(
    middlewares=[
        RetryMiddleware(retries=3),
        LoggingMiddleware()
    ]
)

# Requests will automatically retry on failure and be logged
response = client.get("https://api.example.com/data")

Resource Pattern for REST APIs

import integrates as api

# Create a REST client
client = api.RestClient(base_url="https://api.example.com")

# Create a resource
users = client.resource("users")

# Get all users
all_users = users.get()

# Get a specific user
user = users(123).get()

# Create a user
new_user = users.post(json={"name": "Jane Doe"})

# Update a user
updated_user = users(123).put(json={"name": "Jane Smith"})

# Delete a user
users(123).delete()

Documentation

For more detailed documentation, see the examples directory.

Development

Setup Development Environment

# Clone the repository
git clone https://github.com/caiopizzol/integrates.git
cd integrates

# Install development dependencies
pip install -e ".[dev]"

Run Tests

pytest

License

MIT