graphql-http 2.0.6__tar.gz → 2.1.0__tar.gz

graphql_http-2.1.0/.github/workflows/pages.yml

@@ -0,0 +1,85 @@
+name: Deploy Hugo site to Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/pages.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.146.0
+    steps:
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb          
+      
+      - name: Install Dart Sass
+        run: sudo snap install dart-sass
+      
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      
+      - name: Install Node.js dependencies
+        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+        working-directory: ./docs
+      
+      - name: Install Hugo Book theme
+        run: |
+          git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book || true
+          git submodule update --init --recursive
+        working-directory: ./docs
+      
+      - name: Build with Hugo
+        env:
+          HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
+          HUGO_ENVIRONMENT: production
+          TZ: America/Los_Angeles
+        run: |
+          hugo \
+            --gc \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+        working-directory: ./docs
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/public
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

graphql_http-2.1.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/themes/hugo-book"]
+	path = docs/themes/hugo-book
+	url = https://github.com/alex-shpak/hugo-book

{graphql_http-2.0.6 → graphql_http-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphql_http
-Version: 2.0.6
+Version: 2.1.0
 Summary: HTTP Server for GraphQL.
 Author-email: Robert Parker <rob@parob.com>
 License: MIT
@@ -110,7 +110,7 @@ server.run()
 app = GraphQLHTTP(
     schema=schema,
     serve_graphiql=True,              # Enable GraphiQL interface
-    graphiql_default_query="{ hello }", # Default query in GraphiQL
+    graphiql_example_query="{ hello }", # Example query in GraphiQL
     allow_cors=True,                  # Enable CORS
     health_path="/health"             # Health check endpoint
 )
@@ -147,6 +147,32 @@ app = GraphQLHTTP(
 )
 ```
 
+## GraphiQL Example Queries
+
+You can provide an example query for GraphiQL to show users how your API works. There are 3 ways to do this:
+
+**1. Pass a string directly:**
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    graphiql_example_query="{ users { id name } }"
+)
+```
+
+**2. Load from a file:**
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    graphiql_example_query_path="./queries/example.graphql"
+)
+```
+
+**3. Auto-discovery (no config needed):**
+
+Just create a `graphiql_example.graphql` or `example.graphql` file in your working directory and the server will automatically find and use it.
+
+If you provide multiple sources, the string parameter takes priority, then the file path, then auto-discovery.
+
 ## API Reference
 
 ### GraphQLHTTP Class
@@ -158,7 +184,8 @@ app = GraphQLHTTP(
 - `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
+- `graphiql_example_query` (str, optional): Example query for GraphiQL interface
+- `graphiql_example_query_path` (str, optional): Path to file containing example 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

{graphql_http-2.0.6 → graphql_http-2.1.0}/README.md

@@ -82,7 +82,7 @@ server.run()
 app = GraphQLHTTP(
     schema=schema,
     serve_graphiql=True,              # Enable GraphiQL interface
-    graphiql_default_query="{ hello }", # Default query in GraphiQL
+    graphiql_example_query="{ hello }", # Example query in GraphiQL
     allow_cors=True,                  # Enable CORS
     health_path="/health"             # Health check endpoint
 )
@@ -119,6 +119,32 @@ app = GraphQLHTTP(
 )
 ```
 
+## GraphiQL Example Queries
+
+You can provide an example query for GraphiQL to show users how your API works. There are 3 ways to do this:
+
+**1. Pass a string directly:**
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    graphiql_example_query="{ users { id name } }"
+)
+```
+
+**2. Load from a file:**
+```python
+app = GraphQLHTTP(
+    schema=schema,
+    graphiql_example_query_path="./queries/example.graphql"
+)
+```
+
+**3. Auto-discovery (no config needed):**
+
+Just create a `graphiql_example.graphql` or `example.graphql` file in your working directory and the server will automatically find and use it.
+
+If you provide multiple sources, the string parameter takes priority, then the file path, then auto-discovery.
+
 ## API Reference
 
 ### GraphQLHTTP Class
@@ -130,7 +156,8 @@ app = GraphQLHTTP(
 - `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
+- `graphiql_example_query` (str, optional): Example query for GraphiQL interface
+- `graphiql_example_query_path` (str, optional): Path to file containing example 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

graphql_http-2.1.0/VERSION

@@ -0,0 +1 @@
+2.1.0

graphql_http-2.1.0/docs/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/hugo-book"]
+	path = themes/hugo-book
+	url = https://github.com/alex-shpak/hugo-book

graphql_http-2.1.0/docs/content/_index.md

@@ -0,0 +1,103 @@
+---
+title: GraphQL HTTP Server
+type: docs
+---
+
+# GraphQL HTTP Server
+
+{{< columns >}}
+
+## High Performance
+
+Built on Starlette/ASGI for excellent async performance, handling thousands of concurrent requests efficiently.
+
+<--->
+
+## Authentication Ready  
+
+Built-in JWT authentication with JWKS support for secure GraphQL APIs in production environments.
+
+<--->
+
+## Developer Friendly
+
+Integrated GraphiQL interface, comprehensive error handling, and easy testing capabilities.
+
+{{< /columns >}}
+
+---
+
+## 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
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install graphql-http
+```
+
+### 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)
+```
+
+Visit [http://localhost:8000/graphql](http://localhost:8000/graphql) to access the GraphiQL interface.
+
+## Integration with GraphQL-API
+
+For advanced schema definition with automatic type inference:
+
+```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()
+```
+
+## Next Steps
+
+{{< button relref="/docs/getting-started" >}}Get Started{{< /button >}}
+{{< button relref="/docs/examples" >}}Examples{{< /button >}}
+{{< button relref="/docs/api-reference" >}}API Reference{{< /button >}}

graphql_http-2.1.0/docs/content/docs/_index.md

@@ -0,0 +1,30 @@
+---
+title: Documentation
+type: docs
+bookCollapseSection: true
+weight: 1
+---
+
+# GraphQL HTTP Server Documentation
+
+Welcome to the GraphQL HTTP Server documentation. This server provides a production-ready solution for serving GraphQL APIs over HTTP with extensive features for authentication, CORS, and development tools.
+
+## Core Concepts
+
+- **HTTP Server**: ASGI-based server built on Starlette for high performance
+- **GraphQL Integration**: Seamless integration with any GraphQL schema
+- **Authentication**: Built-in JWT authentication with JWKS support
+- **Development Tools**: Integrated GraphiQL interface and testing utilities
+
+## Getting Started
+
+New to GraphQL HTTP Server? Start with our [Getting Started](./getting-started) guide.
+
+## Documentation Structure
+
+- **[Getting Started](./getting-started)**: Installation and basic setup
+- **[Configuration](./configuration)**: Server configuration options
+- **[Authentication](./authentication)**: JWT authentication setup
+- **[Examples](./examples)**: Practical usage examples
+- **[API Reference](./api-reference)**: Complete API documentation
+- **[Testing](./testing)**: Testing your GraphQL server