celery-fastapi 0.1.0__tar.gz

celery_fastapi-0.1.0/LICENSE

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

celery_fastapi-0.1.0/PKG-INFO

@@ -0,0 +1,410 @@
+Metadata-Version: 2.4
+Name: celery-fastapi
+Version: 0.1.0
+Summary: Automatic REST API generation for Celery tasks with FastAPI
+License: MIT
+License-File: LICENSE
+Keywords: celery,fastapi,rest,api,tasks,async,queue
+Author: Your Name
+Author-email: your.email@example.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Provides-Extra: all
+Provides-Extra: cli
+Provides-Extra: eventlet
+Provides-Extra: gevent
+Provides-Extra: gunicorn
+Provides-Extra: multipart
+Provides-Extra: orjson
+Provides-Extra: rabbitmq
+Provides-Extra: redis
+Provides-Extra: server
+Provides-Extra: standard
+Provides-Extra: ujson
+Provides-Extra: uvicorn
+Requires-Dist: celery (>=5.3.0)
+Requires-Dist: eventlet (>=0.33.0) ; extra == "eventlet"
+Requires-Dist: fastapi (>=0.100.0)
+Requires-Dist: gevent (>=23.0.0) ; extra == "gevent"
+Requires-Dist: gunicorn (>=21.0.0) ; extra == "gunicorn" or extra == "all"
+Requires-Dist: httpx (>=0.27.0) ; extra == "all"
+Requires-Dist: kombu (>=5.3.0) ; extra == "rabbitmq" or extra == "all"
+Requires-Dist: orjson (>=3.9.0) ; extra == "orjson" or extra == "all"
+Requires-Dist: pydantic (>=2.0.0)
+Requires-Dist: python-multipart (>=0.0.6) ; extra == "multipart" or extra == "all"
+Requires-Dist: redis (>=5.0.0) ; extra == "redis" or extra == "standard" or extra == "all"
+Requires-Dist: rich (>=13.0.0) ; extra == "cli" or extra == "standard" or extra == "all"
+Requires-Dist: typer (>=0.9.0) ; extra == "cli" or extra == "standard" or extra == "all"
+Requires-Dist: ujson (>=5.8.0) ; extra == "ujson"
+Requires-Dist: uvicorn[standard] (>=0.23.0) ; extra == "uvicorn" or extra == "gunicorn" or extra == "server" or extra == "cli" or extra == "standard" or extra == "all"
+Project-URL: Documentation, https://github.com/karailker/celery-fastapi#readme
+Project-URL: Homepage, https://github.com/karailker/celery-fastapi
+Project-URL: Repository, https://github.com/karailker/celery-fastapi
+Description-Content-Type: text/markdown
+
+# Celery FastAPI
+
+[![CI](https://github.com/karailker/celery-fastapi/actions/workflows/ci.yml/badge.svg)](https://github.com/karailker/celery-fastapi/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/celery-fastapi.svg)](https://badge.fury.io/py/celery-fastapi)
+[![Python Version](https://img.shields.io/pypi/pyversions/celery-fastapi.svg)](https://pypi.org/project/celery-fastapi/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Automatic REST API generation for Celery tasks with FastAPI. This package seamlessly bridges Celery and FastAPI, automatically creating REST endpoints for all your registered Celery tasks.
+
+## Features
+
+- 🚀 **Automatic endpoint generation** - REST APIs created automatically for all Celery tasks
+- 🔧 **Zero configuration** - Works out of the box with sensible defaults
+- 📊 **Task monitoring** - Built-in endpoints for task status, revocation, and worker info
+- 🎯 **App-scoped operations** - Only manages tasks from your specific Celery app, not the entire cluster
+- 🖥️ **CLI support** - Run as a standalone server from command line
+- 📦 **Modular design** - Use as a library or standalone application
+- 🔄 **Queue-aware routing** - Respects Celery queue assignments
+- 📝 **OpenAPI documentation** - Full Swagger/ReDoc support
+- 🔒 **Production ready** - Full uvicorn/gunicorn support with SSL, workers, and all options
+- ⚡ **Full Celery options** - All task options (countdown, eta, priority, etc.)
+- 🔌 **Pool support** - Compatible with eventlet, gevent, prefork, and solo pools
+
+## Requirements
+
+- Python 3.11+
+- FastAPI 0.100.0+
+- Celery 5.3.0+
+
+## Installation
+
+```bash
+# Basic installation
+pip install celery-fastapi
+
+# With CLI support
+pip install celery-fastapi[cli]
+
+# With uvicorn server
+pip install celery-fastapi[server]
+
+# With gunicorn for production
+pip install celery-fastapi[gunicorn]
+
+# With Redis broker
+pip install celery-fastapi[redis]
+
+# With RabbitMQ broker
+pip install celery-fastapi[rabbitmq]
+
+# With eventlet/gevent concurrency
+pip install celery-fastapi[eventlet]
+pip install celery-fastapi[gevent]
+
+# All extras (recommended for production)
+pip install celery-fastapi[all]
+```
+
+Or with Poetry:
+
+```bash
+poetry add celery-fastapi
+poetry add celery-fastapi --extras cli  # for CLI support
+```
+
+## Quick Start
+
+### As a Python Module
+
+```python
+from celery import Celery
+from celery_fastapi import CeleryFastAPIBridge, create_app
+
+# Your existing Celery app
+celery_app = Celery('tasks', broker='redis://localhost:6379/0')
+
+@celery_app.task
+def add(x, y):
+    return x + y
+
+@celery_app.task
+def multiply(x, y):
+    return x * y
+
+# Option 1: Using create_app factory
+app = create_app(celery_app)
+
+# Option 2: Using the Bridge class for more control
+from fastapi import FastAPI
+
+fastapi_app = FastAPI(title="My Task API")
+bridge = CeleryFastAPIBridge(celery_app, fastapi_app)
+bridge.register_routes()
+```
+
+Run with uvicorn:
+
+```bash
+uvicorn myapp:app --reload
+```
+
+### Using the CLI
+
+```bash
+# Start the server (development)
+celery-fastapi serve myapp.celery:celery_app --port 8000 --reload
+
+# Production with multiple workers
+celery-fastapi serve myapp.celery:celery_app -w 4 --host 0.0.0.0
+
+# With SSL
+celery-fastapi serve myapp.celery:celery_app --ssl-keyfile key.pem --ssl-certfile cert.pem
+
+# Using gunicorn (production)
+celery-fastapi serve-gunicorn myapp.celery:celery_app -w 4 -k uvicorn.workers.UvicornWorker
+
+# List available routes
+celery-fastapi routes myapp.celery:celery_app
+
+# List registered tasks
+celery-fastapi tasks myapp.celery:celery_app
+
+# Show active workers
+celery-fastapi workers myapp.celery:celery_app
+```
+
+## API Endpoints
+
+Once running, your Celery tasks are available as REST endpoints:
+
+### Task Execution
+
+```bash
+# Execute a task with basic args
+POST /{task_name_with_slashes}
+Content-Type: application/json
+
+{
+    "args": [1, 2],
+    "kwargs": {}
+}
+
+# Execute with advanced Celery options
+POST /myapp/process_data
+Content-Type: application/json
+
+{
+    "args": ["data.csv"],
+    "kwargs": {"output_format": "json"},
+    "countdown": 60,
+    "priority": 5,
+    "queue": "high_priority",
+    "time_limit": 300,
+    "soft_time_limit": 280
+}
+
+# Response
+{
+    "task_id": "abc123-def456-...",
+    "status": "PENDING"
+}
+```
+
+### Task Status
+
+```bash
+# Get task status
+GET /tasks/{task_id}
+
+# Response
+{
+    "task_id": "abc123-def456-...",
+    "state": "SUCCESS",
+    "result": 3,
+    "traceback": null,
+    "date_done": "2024-01-15T10:30:00Z"
+}
+```
+
+### Task Management
+
+```bash
+# Revoke a task
+POST /tasks/{task_id}/revoke
+Content-Type: application/json
+
+{
+    "terminate": true,
+    "signal": "SIGTERM"
+}
+
+# Get task result only
+GET /tasks/{task_id}/result
+
+# List active workers (filtered to this app's tasks)
+GET /workers
+
+# List available tasks in THIS app
+GET /available-tasks
+
+# Response
+{
+    "app_name": "my_tasks",
+    "task_count": 4,
+    "tasks": [
+        {"name": "my_tasks.add", "queue": "default", ...},
+        {"name": "my_tasks.multiply", "queue": "default", ...}
+    ]
+}
+
+# List queues
+GET /queues
+
+# Purge tasks from a queue
+POST /purge
+```
+
+### List All Tasks
+
+```bash
+# List active, scheduled, reserved, and revoked tasks (filtered to this app only)
+GET /tasks
+
+# Response
+{
+    "active": {...},
+    "scheduled": {...},
+    "reserved": {...},
+    "revoked": {...}
+}
+```
+
+## Configuration
+
+### CeleryFastAPIBridge Options
+
+```python
+bridge = CeleryFastAPIBridge(
+    celery_app=celery_app,
+    fastapi_app=fastapi_app,  # Optional, creates new if not provided
+    prefix="/api/v1",         # URL prefix for all endpoints
+    include_status_endpoints=True,  # Include /tasks endpoints
+    task_filter=lambda name: not name.startswith("internal."),  # Filter tasks
+)
+```
+
+### create_app Options
+
+```python
+app = create_app(
+    celery_app,  # Celery instance or module path string
+    title="My API",
+    description="Task API",
+    version="1.0.0",
+    prefix="/api",
+    include_status_endpoints=True,
+    fastapi_kwargs={"docs_url": "/swagger"},
+)
+```
+
+## Integration with Existing FastAPI App
+
+```python
+from fastapi import FastAPI
+from celery_fastapi import CeleryFastAPIBridge
+from myapp import celery_app
+
+app = FastAPI()
+
+# Your existing routes
+@app.get("/health")
+def health_check():
+    return {"status": "healthy"}
+
+# Add Celery task endpoints under /celery prefix
+bridge = CeleryFastAPIBridge(
+    celery_app,
+    app,
+    prefix="/celery",
+)
+bridge.register_routes()
+```
+
+## CLI Reference
+
+```bash
+celery-fastapi --help
+
+Commands:
+  serve            Start the FastAPI server with uvicorn
+  serve-gunicorn   Start the FastAPI server with Gunicorn
+  routes           List all generated routes
+  tasks            List all registered Celery tasks
+  workers          Show active Celery workers
+
+# Serve options (uvicorn)
+celery-fastapi serve myapp:celery_app \
+    --host 0.0.0.0 \
+    --port 8000 \
+    --reload \
+    --workers 4 \
+    --prefix /api \
+    --log-level info \
+    --ssl-keyfile key.pem \
+    --ssl-certfile cert.pem \
+    --proxy-headers \
+    --forwarded-allow-ips '*'
+
+# Serve options (gunicorn)
+celery-fastapi serve-gunicorn myapp:celery_app \
+    --bind 0.0.0.0:8000 \
+    --workers 4 \
+    --worker-class uvicorn.workers.UvicornWorker \
+    --timeout 30 \
+    --daemon \
+    --pid /var/run/celery-fastapi.pid
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/karailker/celery-fastapi.git
+cd celery-fastapi
+
+# Install dependencies
+poetry install --extras all
+
+# Run tests
+poetry run pytest
+
+# Run linting
+poetry run ruff check .
+poetry run mypy celery_fastapi
+
+# Format code
+poetry run ruff format .
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+