https://github.com/jina-ai/fastapi-serve

FastAPI to the Cloud, Batteries Included! ☁️🔋🚀
https://github.com/jina-ai/fastapi-serve

cloud deployment docker fastapi kubernetes python serverless

Last synced: 7 days ago
JSON representation

FastAPI to the Cloud, Batteries Included! ☁️🔋🚀

• Host: GitHub
• URL: https://github.com/jina-ai/fastapi-serve
• Owner: jina-ai
• License: apache-2.0
• Created: 2023-07-11T08:15:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-22T05:37:58.000Z (over 1 year ago)
• Last Synced: 2025-01-02T14:08:24.074Z (14 days ago)
• Topics: cloud, deployment, docker, fastapi, kubernetes, python, serverless
• Language: Python
• Homepage: https://cloud.jina.ai/
• Size: 363 KB
• Stars: 143
• Watchers: 20
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jina-ai/fastapi-serve - FastAPI to the Cloud, Batteries Included! ☁️🔋🚀 (Python)

README

        


FastAPI-Serve: FastAPI to the Cloud, Batteries Included! ☁️🔋🚀














Welcome to **fastapi-serve**, your one-stop solution for seamless FastAPI application deployments. Powered by our open-source framework [Jina](https://github.com/jina-ai/jina), `fastapi-serve` provides an effortless transition from your local setup to [cloud.jina.ai](https://cloud.jina.ai/), our robust and scalable cloud platform. 🌩️

Designed with developers in mind, `fastapi-serve` simplifies the deployment process by packing robust functionality, ease-of-use, and automated procedures into one comprehensive package. With `fastapi-serve`, we aim to streamline the "last mile" of FastAPI application development, allowing you to focus on what truly matters - writing great code!

## 😍 Features 

- 🌎 **HTTPS**: Auto-provisioned DNS and TLS certificates for your app.

- 🔗 **Protocols**: Full compatibility with HTTP, WebSocket, and GraphQL.

- ↕️ **Scaling**: Scale your app manually or let it auto-scale based on RPS, CPU, and Memory.

- 🗝️ **Secrets**: Secure handling of secrets and environment variables.

- 🎛️ **Hardware**: Choose the right compute resources for your app's needs with ease.

- 🔒 **Authorization**: Built-in `OAuth2.0` token-based security to secure your endpoints. 

- 💾 **App Storage**: Persistent and secure network storage for your app data.

- 🔄 **Blob Storage**: Built-in support for seamless user file uploads and downloads.

- 🔎 **Observability**: Integrated access to logs, metrics, and traces. (Alerting coming soon!)

- 📦 **Containerization**: Effortless containerization of your Python codebase with our integrated registry.

- 🛠️ **Self-Hosting**: Export your app for self-hosting with ease, including docker-compose and Kubernetes YAMLs.

## 💡 Getting Started

First, install the `fastapi-serve` package using pip:

```bash

pip install fastapi-serve

```

Then, simply use the `fastapi-serve` command to deploy your FastAPI application:

```bash

fastapi-serve deploy jcloud main:app

```

You'll get a URL to access your newly deployed application along with the Swagger UI.

## 📚 Documentation

Dive into understanding `fastapi-serve` through our comprehensive documentation and examples:

- 🚀 **Getting Started**

    - 🧱 [Deploy a simple FastAPI application](docs/simple/)

    - 🖥️ [Dig deep into the `fastapi-serve` CLI](docs/CLI.md)

    - ⚙️ [Understanding configuration and pricing on Jina AI Cloud](docs/CONFIG.MD)

    - 🔄 [Upgrade your FastAPI applications with zero downtime](docs/upgrades/)

    - 🕸️ [Managing Larger Applications with Complex Directory Structure](docs/larger/project1)

- ↕️ **Scaling**

    - 💹 [Auto-scaling endpoints based on CPU usage](docs/autoscaling/cpu/)

    - 📉 [Serverless (scale-to-zero) deployments based on RPS](docs/autoscaling/serverless/) 

- 🧩 **Config & Credentials**

    - 🌍 [Leverage environment variables for app configuration](docs/envs/)

    - 🗝️ [Use secrets for Redis-powered rate limiting](docs/rate_limit/)

- 💾 **Storage**

    - 📁 [Manage file uploads and downloads with built-in blob storage](docs/file_handling/)

    - 🌐 Network storage for persisting and securely accessing app data (Documentation in progress 🚧)

- 🔒 **Security**

    - 👮‍♂️ [Secure your endpoints with built-in OAuth2.0 authorization](docs/authorization/)

- 🐳 **Deployment Options**

    - 🚢 Deployment with custom dockerfile (Documentation in progress 🚧)

    - ☸️ [Export your app for self-hosting with docker-compose / Kubernetes](docs/export/)

- 📈 **Observability**

    - 📊 Access logs, metrics, and traces for your app (Documentation in progress 🚧)

    - 🚨 Set up alerts for your app (Documentation in progress 🚧)

## 💪 Support

If you encounter any problems or have questions, feel free to open an issue on the GitHub repository. You can also join our [Discord](https://discord.jina.ai/) to get help from our community members and the Jina team.

## 🌐 Our Cloud Platform  

Our robust and scalable cloud platform `cloud.jina.ai` is designed to run your FastAPI applications with minimum hassle and maximum efficiency. With features like auto-scaling, integrated observability, and automated containerization, it provides a seamless and worry-free deployment experience.

---

`fastapi-serve` is more than just a deployment tool, it's a bridge that connects your local development environment with our powerful cloud infrastructure. Start using `fastapi-serve` today, and experience the joy of effortless deployments! 🎊