Metadata-Version: 2.1
Name: deployplex
Version: 0.0.10
Summary: DeployPlex Python SDK
License: Apache-2.0
Author: Alvaro Molina
Author-email: am@deployplex.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: fastapi (>=0.104.1,<0.105.0)
Description-Content-Type: text/markdown

# DeployPlex Python SDK

`deployplex` is the official DeployPlex SDK for Python

[![pypi version](https://img.shields.io/pypi/v/deployplex.svg)](https://pypi.org/pypi/deployplex/)
[![Downloads](https://static.pepy.tech/badge/deployplex/week)](https://pypi.org/pypi/deployplex/)
[![License: MIT](https://img.shields.io/badge/license-Apache--2.0-yellow)](https://www.apache.org/licenses/LICENSE-2.0)
[![Twitter](https://img.shields.io/twitter/url/https/x.com/deployplex.svg?style=social&label=Follow%20%40deployplex)](https://x.com/deployplex)
[![](https://dcbadge.vercel.app/api/server/BP5aUkhcAh?compact=true&style=flat)](https://discord.com/invite/BP5aUkhcAh)


## Getting Started

### Requirements
- [Python 3.11.2](https://www.python.org/downloads/)

### Install
You can install and configure `deployplex` using this command:
```bash
pip install -U deployplex
```

### Configure
```python
from fastapi import FastAPI
import deployplex.integrations.fastapi as deployplex_fastapi_integration

app = FastAPI()
deployplex_fastapi_integration.init(app)
```

### Auth for DeployPlex CronJob endpoints
```python
from fastapi import FastAPI, Depends, Response
from deployplex.integrations.fastapi import cron_job_auth

app = FastAPI()

@app.post("/job")
def job(auth: None = Depends(cron_job_auth)) -> Response:
    return Response()
```

