Opyrator

Python functions with superpowers. Instantly deploy with REST API, UI, and more.

Getting Started • Features & Screenshots • Support • Report a Bug • Contribution • Changelog

Opyrator enables you to instantly turn a simple Python function into a powerful web service that includes a HTTP REST API and a full-blown graphical UI. It can be saved & shared as self-contained executable file and instantly deployed & scaled for production usage. Opyrator is powered by Pydantic, FastAPI, and Streamlit and enables you to build your web apps and services within seconds.

Alpha Version: This is still under heavy development and only suggested for experimental usage.

Highlights

• 🪄  Turn functions into production-ready services within seconds.
• 🔌  Auto-generated HTTP API based on FastAPI.
• 🌅  Auto-generated Web UI based on Streamlit.
• 📦  Save and share as self-contained executable file or Docker image.
• 🧩  Reuse pre-defined interfaces & combine with existing Opyrators.
• 📈  Instantly deploy and scale for production usage.

Getting Started

Installation

Requirements: Python 3.6+.

pip install opyrator

Usage

1. A simple Opyrator-compatible function could look like this:

   from pydantic import BaseModel
   
   class Input(BaseModel):
       text: str
   
   class Output(BaseModel):
       text: str
   
   def hello_world(input: Input) -> Output:
       return Output(text=input.text)
   

   Requirements: The function needs to be annotated with typing hints, and the input parameter and return value needs to be based on Pydantic models.

2. Copy this code to a file my_opyrator.py

3. Run the UI server from command-line:

   opyrator launch-ui my_opyrator:hello_world
   

   In the output, there's a line that shows where your web app is being served, on your local machine.

   TODO: Add screenshot

4. Run the REST API server from command-line:

   opyrator launch-api my_opyrator:hello_world
   

   In the output, there's a line that shows where your web service is being served, on your local machine.

   TODO: Add screenshot

5. Find out more usage details and features in the Features section.

Support & Feedback

This project is maintained by Benjamin Räthlein, Lukas Masuch, and Jan Kalkan. Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from it.

Type	Channel
🚨  Bug Reports
🎁  Feature Requests
👩‍💻  Usage Questions
📢  Announcements
❓  Other Requests

Features

REST API • Graphical UI • CLI • ZIP Export • Docker Export • Pre-defined Interfaces • Production Deployment

REST API

With Opyrator, you can instantly launch a local HTTP (REST) API server for any compatible function:

opyrator launch-api my_opyrator:hello_world

This will launch a FastAPI server based on the OpenAPI standard and with an automatic interactive documentation.

TODO: Add Screenshot

💡 Make sure that all requirements of your script are installed in the active Python enviornment.

The port used by the API server can be provided via CLI arguments:

opyrator launch-api my_opyrator:hello_world --port 8080

The API server can also be started via the exported zip-file format (see zip export section below).

opyrator launch-api my-opyrator.zip

Graphical UI

You can launch a graphical user interface - powered by Streamlit - for your compatible function. The UI is auto-generated from the input- and output-schema of the given function.

opyrator launch-ui my_opyrator:hello_world

TODO: Screenshot

💡 Make sure that all requirements of your script are installed in the active Python environment.

You can influence most aspects of the UI just by changing and improving the input- and output-schema of your function. Furthermore, it is also possible to define custom UIs for the function's input and output. For more details, refer to the input- and output-schema section.

The port used by the UI server can be provided via CLI arguments:

opyrator launch-ui my_opyrator:hello_world --port 8080

The UI server can also be started via the exported zip-file format (see zip export section below).

opyrator launch-ui my-opyrator.zip

In addition, the UI server can be started by using an already running Opyrator API endpoint:

opyrator launch-ui http://my-opyrator:8080 

Thereby, all Opyrator calls from the UI will be executed via the configured HTTP endpoint instead of the Python function running inside the UI server.

Command-line Interface

An Opyrator can also be executed via command-line:

opyrator call my_opyrator:hello_world '{"text": "hello", "wait": 1}'

TODO: Add screenshot

The CLI interface also works using the zip export format:

opyrator call my-opyrator.zip '{"text": "hello", "wait": 1}'

Or, by using an already running Opyrator API endpoint:

opyrator call http://my-opyrator:8080 '{"text": "hello", "wait": 1}'

Thereby, the function call is executed by the Opyrator API server, instead of locally using the Python function.

ZIP Export

Opyrator allows you to package and export a compatible function into a self-contained ZIP file:

opyrator export my_opyrator:hello_world my-opyrator.zip

This exported ZIP file packages relevant source code and data artifacts into a single file which can be shared, stored, and used for launching the API or UI as shown above.

External requirements are automatically discovered from the working directory based on the following files: Pipfile (Pipenv environment), environment.yml (Conda environment), pyproject.toml (Poetry dependencies), requirements.txt (PIP requirements), setup.py (Python project requirements), packages.txt (apt-get packages), or discovered via pipreqs as fallback. However, external requirements are only included as instructions and are not packaged into the ZIP file. If you want to export your Opyrator fully self-contained including all requirements or even the Python interpreter itself, please refer to the Docker or PEX export options.

As a side note, Opyrators exported as ZIP files are (mini) Python libraries that can be pip-installed, imported, and used from other Python code:

pip install my-opyrator.zip

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here

Docker Export

In addition to the ZIP export, Opyrator also provides the capability to export to a Docker image:

opyrator export my_opyrator:hello_world --docker my-opyrator-image:latest

💡 The Docker export requires that Docker is installed on your machine.

After the successful export, the Docker image can be run as shown below:

docker run -p 8080:8080 my-opyrator-image:latest

Running your Opyrator within this Docker image has the advantage that only a single port is required to be exposed. The separation between UI and API is done via URL paths: http://localhost:8080/api (API); http://localhost:8080/ui (UI). The UI is automatically configured to use the API for all function calls.

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here.

PEX Export

Opyrator also provides the capability to export to a PEX file. PEX is a tool to create self-contained executable Python environments that contain all relevant python dependencies.

opyrator export my_opyrator:hello_world --pex my-opyrator.pex

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here.

Python Client

Every deployed Opyrator provides a Python client library via an endpoint method which can be installed with pip:

pip install http://my-opyrator:8080/client

And used in your code, as shown below:

from my_opyrator import Client, Input
opyrator_client = Client("http://my-opyrator:8080")
result = opyrator_client.call(Input(text="hello", wait=1))

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here.

Pre-defined Interfaces

Opyrator provides a growing collection of pre-defined interfaces (input- and output schemas) for common tasks. Some of these interfaces also provide more advanced UIs and Visualizations. You can reuse these schemas to speed up your development and, thereby, also keep your Opyrators compatible to other functionality improvements or other Opyrators.

You can find some of the available interfaces in the examples section or in this source code package.

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here.

Production Deployment

Rolling out your Opyrators for production usage might require additional features such as SSL, authentication, API tokens, unlimited scalability, load balancing, and monitoring. Therefore, we provide capabilities to easily deploy your Opyrators directly on scalable and secure cloud platforms without any major overhead:

opyrator deploy my_opyrator:hello_world <deployment-provider> <deployment-provider-options>

WIP: This feature is not finalized yet. You can track the progress and vote for the feature here.

Documentation

Compatible Functions

A function is compatible with Opyrator if it fullfills the following requirements:

• A single parameter called input which MUST be a subclass of the Pydantic BaseModel.
• A single return value which MUST be a subclass of the Pydantic BaseModel.
• The input parameter and return value MUST be annotated with Python typing hints.

Input- and Output-Schema

TODO

These input- and output-models are used to generate the REST API and Web UI.

TODO: Add mapping table between JSON Schema and UI elements.

Command-line Interface

TODO: Add help output of CLI

Examples

TODO: Add examples

Contribution

• Pull requests are encouraged and always welcome. Read our contribution guidelines and check out help-wanted issues.
• Submit Github issues for any feature request and enhancement, bugs, or documentation problems.
• By participating in this project, you agree to abide by its Code of Conduct.
• The development section below contains information on how to build and test the project after you have implemented some changes.

Development

Requirements: Docker and Act are required to be installed on your machine to execute the containerized build process.

To simplify the process of building this project from scratch, we provide build-scripts - based on universal-build - that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:

act -b -j build

Refer to our contribution guides for more detailed information on our build scripts and development process.

Licensed MIT. Created and maintained with ❤️  by developers from Berlin.