banesullivan / server-thread

⚙️ Launch a WSGI or ASGI Application in a background thread with werkzeug or uvicorn

⚙️ Server Thread

Launch a WSGI or ASGI Application in a background thread with werkzeug or uvicorn.

This application was created for localtileserver and provides the basis for how it can launch an image tile server as a background thread for visualizing data in Jupyter notebooks.

While this may not be a widely applicable library, it is useful for a few Python packages I have created that require a background service.

🚀 Usage

Use the ServerThread with any WSGI or ASGI Application.

Start by creating a application (this can be a flask app or a simple app like below):

# Create some WSGI Application
from werkzeug import Request, Response

@Request.application
def app(request):
    return Response("howdy", 200)

Then launch the app with the ServerThread class:

import requests
from server_thread import ServerThread

# Launch app in a background thread
server = ServerThread(app)

# Perform requests against the server without blocking
requests.get(f"http://{server.host}:{server.port}/").raise_for_status()

⬇️ Installation

Get started with server-thread to create applications that require a WSGIApplication in the background.

🐍 Installing with conda

Conda makes managing server-thread's dependencies across platforms quite easy and this is the recommended method to install:

conda install -c conda-forge server-thread

🎡 Installing with pip

If you prefer pip, then you can install from PyPI: https://pypi.org/project/server-thread/

pip install server-thread

💭 Feedback

Please share your thoughts and questions on the Discussions board. If you would like to report any bugs or make feature requests, please open an issue.

If filing a bug report, please share a scooby Report:

import server_thread
print(server_thread.Report())

🚀 Examples

Minimal examples for using server-thread with common micro-frameworks.

💨 FastAPI

import requests
from fastapi import FastAPI
from server_thread import ServerThread

app = FastAPI()


@app.get("/")
def root():
    return {"message": "Howdy!"}


server = ServerThread(app)
requests.get(f"http://{server.host}:{server.port}/").json()

⚗️ Flask

import requests
from flask import Flask
from server_thread import ServerThread

app = Flask("testapp")


@app.route("/")
def howdy():
    return {"message": "Howdy!"}


server = ServerThread(app)
requests.get(f"http://{server.host}:{server.port}/").json()