graphql-http 1.6.2__tar.gz → 2.0.2__tar.gz

graphql_http-2.0.2/.github/workflows/python-package.yml

@@ -0,0 +1,78 @@
+name: Python Package CI/CD
+
+on:
+  push:
+    branches:
+      - main # Or your default branch
+    tags:
+      - '*.*.*' # For publishing to PyPI
+  pull_request:
+    branches:
+      - main # Or your default branch
+
+jobs:
+  build_and_test:
+    name: Build and Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"] # graphql-api requires Python 3.11+
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install UV
+      uses: astral-sh/setup-uv@v3
+
+    - name: Install dependencies
+      run: uv sync --dev
+
+    - name: Lint with Flake8
+      run: uv run flake8 graphql_http tests
+
+    - name: Test with Pytest
+      run: uv run pytest
+
+  publish:
+    name: Publish to PyPI
+    needs: build_and_test # Ensure tests pass before publishing
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Validate tag format (e.g., 1.0.0)
+      run: |
+        TAG_NAME="${{ github.ref_name }}"
+        if ! [[ "$TAG_NAME" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+          echo "Error: Tag '$TAG_NAME' is not in the required X.Y.Z numeric format (e.g., 1.0.0)."
+          exit 1
+        fi
+        echo "Tag '$TAG_NAME' is valid."
+      shell: bash
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12' # Use compatible Python version for publishing
+
+    - name: Install UV
+      uses: astral-sh/setup-uv@v3
+
+    - name: Update VERSION file
+      run: echo "${{ github.ref_name }}" > VERSION
+      shell: bash
+
+    - name: Build and publish package to PyPI
+      run: uv build && uv publish

graphql_http-2.0.2/.gitignore

@@ -0,0 +1,24 @@
+*.pyc
+.DS_Store
+Pipfile.lock
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/

graphql_http-2.0.2/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: graphql_http
+Version: 2.0.2
+Summary: HTTP Server for GraphQL.
+Author-email: Robert Parker <rob@parob.com>
+License: MIT
+Project-URL: Homepage, https://gitlab.com/parob/graphql-http
+Project-URL: Repository, https://gitlab.com/parob/graphql-http
+Keywords: GraphQL,HTTP,Server,starlette
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.13,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: graphql-core
+Requires-Dist: graphql-api
+Requires-Dist: packaging
+Requires-Dist: graphql-schema-diff
+Requires-Dist: pyjwt[crypto]
+Requires-Dist: starlette
+Requires-Dist: uvicorn
+Requires-Dist: python-multipart
+Requires-Dist: httpx
+Dynamic: license-file
+
+# GraphQL HTTP Server
+
+A lightweight, production-ready HTTP server for GraphQL APIs built on top of Starlette/FastAPI. This server provides a simple yet powerful way to serve GraphQL schemas over HTTP with built-in support for authentication, CORS, GraphiQL integration, and more.
+
+## Features
+
+- 🚀 **High Performance**: Built on Starlette/ASGI for excellent async performance
+- 🔐 **JWT Authentication**: Built-in JWT authentication with JWKS support
+- 🌐 **CORS Support**: Configurable CORS middleware for cross-origin requests
+- 🎨 **GraphiQL Integration**: Interactive GraphQL IDE for development
+- 📊 **Health Checks**: Built-in health check endpoints
+- 🔄 **Batch Queries**: Support for batched GraphQL operations
+- 🛡️ **Error Handling**: Comprehensive error handling and formatting
+- 📝 **Type Safety**: Full TypeScript-style type hints for Python
+
+## Installation
+
+```bash
+uv add graphql_http
+```
+
+Or with pip:
+```bash
+pip install graphql_http
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from graphql import GraphQLSchema, GraphQLObjectType, GraphQLField, GraphQLString
+from graphql_http import GraphQLHTTP
+
+# Define your GraphQL schema
+schema = GraphQLSchema(
+    query=GraphQLObjectType(
+        name="Query",
+        fields={
+            "hello": GraphQLField(
+                GraphQLString,
+                resolve=lambda obj, info: "Hello, World!"
+            )
+        }
+    )
+)
+
+# Create the HTTP server
+app = GraphQLHTTP(schema=schema)
+
+# Run the server
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)
+```
+
+### Using with GraphQL-API
+
+For more advanced schemas, integrate with `graphql-api`:
+
+```python
+from graphql_api import GraphQLAPI
+from graphql_http import GraphQLHTTP
+
+api = GraphQLAPI()
+
+@api.type(is_root_type=True)
+class Query:
+    @api.field
+    def hello(self, name: str = "World") -> str:
+        return f"Hello, {name}!"
+
+# Create server from API
+server = GraphQLHTTP.from_api(api)
+server.run()
+```
+
+## Configuration Options
+
+### Basic Configuration
+
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    serve_graphiql=True,              # Enable GraphiQL interface
+    graphiql_default_query="{ hello }", # Default query in GraphiQL
+    allow_cors=True,                  # Enable CORS
+    health_path="/health"             # Health check endpoint
+)
+```
+
+### Authentication Configuration
+
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    auth_enabled=True,
+    auth_jwks_uri="https://your-auth0-domain/.well-known/jwks.json",
+    auth_issuer="https://your-auth0-domain/",
+    auth_audience="your-api-audience",
+    auth_enabled_for_introspection=False  # Allow introspection without auth
+)
+```
+
+### Advanced Configuration
+
+```python
+from graphql.execution import ExecutionContext
+
+class CustomExecutionContext(ExecutionContext):
+    # Custom execution logic
+    pass
+
+app = GraphQLHTTP(
+    schema=schema,
+    root_value={"version": "1.0"},
+    middleware=[your_middleware_function],
+    context_value=custom_context,
+    execution_context_class=CustomExecutionContext
+)
+```
+
+## API Reference
+
+### GraphQLHTTP Class
+
+#### Constructor Parameters
+
+- `schema` (GraphQLSchema): The GraphQL schema to serve
+- `root_value` (Any, optional): Root value passed to resolvers
+- `middleware` (List[Callable], optional): List of middleware functions
+- `context_value` (Any, optional): Context passed to resolvers
+- `serve_graphiql` (bool, default: True): Whether to serve GraphiQL interface
+- `graphiql_default_query` (str, optional): Default query for GraphiQL
+- `allow_cors` (bool, default: False): Enable CORS middleware
+- `health_path` (str, optional): Path for health check endpoint
+- `execution_context_class` (Type[ExecutionContext], optional): Custom execution context
+- `auth_enabled` (bool, default: False): Enable JWT authentication
+- `auth_jwks_uri` (str, optional): JWKS URI for JWT validation
+- `auth_issuer` (str, optional): Expected JWT issuer
+- `auth_audience` (str, optional): Expected JWT audience
+- `auth_enabled_for_introspection` (bool, default: False): Require auth for introspection
+
+#### Methods
+
+- `from_api(api, **kwargs)`: Create server from GraphQL-API instance
+- `run(host, port, **kwargs)`: Run the server
+- `client()`: Get test client for testing
+
+## HTTP Endpoints
+
+### POST /graphql
+
+Execute GraphQL operations:
+
+```bash
+curl -X POST http://localhost:8000/graphql \
+  -H "Content-Type: application/json" \
+  -d '{"query": "{ hello }"}'
+```
+
+### GET /graphql
+
+Execute GraphQL queries via GET (with query parameter):
+
+```bash
+curl "http://localhost:8000/graphql?query={hello}"
+```
+
+Access GraphiQL interface in browser:
+
+```
+http://localhost:8000/graphql
+```
+
+### GET /health
+
+Health check endpoint (if configured):
+
+```bash
+curl http://localhost:8000/health
+```
+
+## Authentication
+
+When authentication is enabled, requests must include a valid JWT token:
+
+```bash
+curl -X POST http://localhost:8000/graphql \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
+  -d '{"query": "{ hello }"}'
+```
+
+## Testing
+
+The server includes a built-in test client:
+
+```python
+from graphql_http import GraphQLHTTP
+
+server = GraphQLHTTP(schema=schema)
+client = server.client()
+
+response = client.post("/graphql", json={"query": "{ hello }"})
+assert response.status_code == 200
+assert response.json() == {"data": {"hello": "Hello, World!"}}
+```
+
+## Error Handling
+
+The server provides comprehensive error handling:
+
+- **400 Bad Request**: Malformed queries or invalid JSON
+- **401 Unauthorized**: Invalid or missing authentication
+- **405 Method Not Allowed**: Invalid HTTP method
+- **500 Internal Server Error**: Server-side errors
+
+## Development
+
+### Running Tests
+
+With UV:
+```bash
+uv run pytest tests/ -v
+```
+
+Or with Python directly:
+```bash
+python -m pytest tests/ -v
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for your changes
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Changelog
+
+See CHANGELOG.md for version history and updates.

graphql_http-2.0.2/README.md

@@ -0,0 +1,246 @@
+# GraphQL HTTP Server
+
+A lightweight, production-ready HTTP server for GraphQL APIs built on top of Starlette/FastAPI. This server provides a simple yet powerful way to serve GraphQL schemas over HTTP with built-in support for authentication, CORS, GraphiQL integration, and more.
+
+## Features
+
+- 🚀 **High Performance**: Built on Starlette/ASGI for excellent async performance
+- 🔐 **JWT Authentication**: Built-in JWT authentication with JWKS support
+- 🌐 **CORS Support**: Configurable CORS middleware for cross-origin requests
+- 🎨 **GraphiQL Integration**: Interactive GraphQL IDE for development
+- 📊 **Health Checks**: Built-in health check endpoints
+- 🔄 **Batch Queries**: Support for batched GraphQL operations
+- 🛡️ **Error Handling**: Comprehensive error handling and formatting
+- 📝 **Type Safety**: Full TypeScript-style type hints for Python
+
+## Installation
+
+```bash
+uv add graphql_http
+```
+
+Or with pip:
+```bash
+pip install graphql_http
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from graphql import GraphQLSchema, GraphQLObjectType, GraphQLField, GraphQLString
+from graphql_http import GraphQLHTTP
+
+# Define your GraphQL schema
+schema = GraphQLSchema(
+    query=GraphQLObjectType(
+        name="Query",
+        fields={
+            "hello": GraphQLField(
+                GraphQLString,
+                resolve=lambda obj, info: "Hello, World!"
+            )
+        }
+    )
+)
+
+# Create the HTTP server
+app = GraphQLHTTP(schema=schema)
+
+# Run the server
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)
+```
+
+### Using with GraphQL-API
+
+For more advanced schemas, integrate with `graphql-api`:
+
+```python
+from graphql_api import GraphQLAPI
+from graphql_http import GraphQLHTTP
+
+api = GraphQLAPI()
+
+@api.type(is_root_type=True)
+class Query:
+    @api.field
+    def hello(self, name: str = "World") -> str:
+        return f"Hello, {name}!"
+
+# Create server from API
+server = GraphQLHTTP.from_api(api)
+server.run()
+```
+
+## Configuration Options
+
+### Basic Configuration
+
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    serve_graphiql=True,              # Enable GraphiQL interface
+    graphiql_default_query="{ hello }", # Default query in GraphiQL
+    allow_cors=True,                  # Enable CORS
+    health_path="/health"             # Health check endpoint
+)
+```
+
+### Authentication Configuration
+
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    auth_enabled=True,
+    auth_jwks_uri="https://your-auth0-domain/.well-known/jwks.json",
+    auth_issuer="https://your-auth0-domain/",
+    auth_audience="your-api-audience",
+    auth_enabled_for_introspection=False  # Allow introspection without auth
+)
+```
+
+### Advanced Configuration
+
+```python
+from graphql.execution import ExecutionContext
+
+class CustomExecutionContext(ExecutionContext):
+    # Custom execution logic
+    pass
+
+app = GraphQLHTTP(
+    schema=schema,
+    root_value={"version": "1.0"},
+    middleware=[your_middleware_function],
+    context_value=custom_context,
+    execution_context_class=CustomExecutionContext
+)
+```
+
+## API Reference
+
+### GraphQLHTTP Class
+
+#### Constructor Parameters
+
+- `schema` (GraphQLSchema): The GraphQL schema to serve
+- `root_value` (Any, optional): Root value passed to resolvers
+- `middleware` (List[Callable], optional): List of middleware functions
+- `context_value` (Any, optional): Context passed to resolvers
+- `serve_graphiql` (bool, default: True): Whether to serve GraphiQL interface
+- `graphiql_default_query` (str, optional): Default query for GraphiQL
+- `allow_cors` (bool, default: False): Enable CORS middleware
+- `health_path` (str, optional): Path for health check endpoint
+- `execution_context_class` (Type[ExecutionContext], optional): Custom execution context
+- `auth_enabled` (bool, default: False): Enable JWT authentication
+- `auth_jwks_uri` (str, optional): JWKS URI for JWT validation
+- `auth_issuer` (str, optional): Expected JWT issuer
+- `auth_audience` (str, optional): Expected JWT audience
+- `auth_enabled_for_introspection` (bool, default: False): Require auth for introspection
+
+#### Methods
+
+- `from_api(api, **kwargs)`: Create server from GraphQL-API instance
+- `run(host, port, **kwargs)`: Run the server
+- `client()`: Get test client for testing
+
+## HTTP Endpoints
+
+### POST /graphql
+
+Execute GraphQL operations:
+
+```bash
+curl -X POST http://localhost:8000/graphql \
+  -H "Content-Type: application/json" \
+  -d '{"query": "{ hello }"}'
+```
+
+### GET /graphql
+
+Execute GraphQL queries via GET (with query parameter):
+
+```bash
+curl "http://localhost:8000/graphql?query={hello}"
+```
+
+Access GraphiQL interface in browser:
+
+```
+http://localhost:8000/graphql
+```
+
+### GET /health
+
+Health check endpoint (if configured):
+
+```bash
+curl http://localhost:8000/health
+```
+
+## Authentication
+
+When authentication is enabled, requests must include a valid JWT token:
+
+```bash
+curl -X POST http://localhost:8000/graphql \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
+  -d '{"query": "{ hello }"}'
+```
+
+## Testing
+
+The server includes a built-in test client:
+
+```python
+from graphql_http import GraphQLHTTP
+
+server = GraphQLHTTP(schema=schema)
+client = server.client()
+
+response = client.post("/graphql", json={"query": "{ hello }"})
+assert response.status_code == 200
+assert response.json() == {"data": {"hello": "Hello, World!"}}
+```
+
+## Error Handling
+
+The server provides comprehensive error handling:
+
+- **400 Bad Request**: Malformed queries or invalid JSON
+- **401 Unauthorized**: Invalid or missing authentication
+- **405 Method Not Allowed**: Invalid HTTP method
+- **500 Internal Server Error**: Server-side errors
+
+## Development
+
+### Running Tests
+
+With UV:
+```bash
+uv run pytest tests/ -v
+```
+
+Or with Python directly:
+```bash
+python -m pytest tests/ -v
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for your changes
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Changelog
+
+See CHANGELOG.md for version history and updates.

graphql_http-2.0.2/VERSION

@@ -0,0 +1 @@
+2.0.2