README.md

Django Thrift

Run an Apache Thrift RPC Server through Django.

Installation

Install with pip.

pip install django-thrift

Configuration

To configure the application, you will need to add django_thrift to your INSTALLED_APPS.

INSTALLED_APPS = [
    ...  # Make sure to include the default installed apps here.
    'django_thrift',
]

You will also need to include the location and service name for your Thrift File. This also goes in settings.py

THRIFT = {
    "FILE": "pingpong.thrift",
    "SERVICE": "PingPong"
}

Mapping Thrift Function to Python

To map a Thrift function to our Django application, we will use a Service Handler. In our views.py function we can set up one of our routes like so.

from django_thrift.handler import create_handler


handler = create_handler()  # Create the service handler that maps


@handler.map_function("ping")  # Maps the `ping_handler` function to Thrift `ping` 
def ping_handler():
    return "pong"

If your function takes in Thrift variables or structs, then you can pass them as variables to the function and they will be passed.

Accessing the Thrift Classes

To access and use the Thrift classes defined in your Thrift file, include the import below to your module. The name of this variable may very well change come v0.1.2

from django_thrift.server.rpc import THRIFT_MOD

Management

To run the RPC Server, run the following command. Note that you will need the DJANGO_SETTINGS_MODULE defined so that Django Thrift can load the correct settings.

./manange.py runrpcserver

Deployment

To deploy the RPC server to production, use gunicorn_thrift with the command below...

gunicorn_thrift django_thrift.server.rpc:APP

Example

service PingPong {
    string ping(),
}