Skip to main content

gRPC for Django

Project description

https://badge.fury.io/py/django-grpc-framework.svg https://travis-ci.org/itswcg/django-grpc-framework.svg?branch=master https://readthedocs.org/projects/django-grpc-framework/badge/?version=latest https://codecov.io/gh/itswcg/django-grpc-framework/branch/master/graph/badge.svg

gRPC for Django inspired by djangorestframework.

Documentation

The full documentation is at https://django-grpc-framework.readthedocs.io.

Quickstart

Install django-grpc-framework:

pip install django-grpc-framework

Add it to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'grpc_framework',
]

Create your grpc app:

python manage.py grpcstartapp <app_name>

Define your proto in <app_name>/<app_name>.proto.

Add your app to GRPC_APPS:

GRPC_APPS = [
    '<app_name>',
]

Generate protocol buffer compiler:

python manage.py grpcgenerate

Create your service in <app_name>/service.py.

Start a grpc server with your apps:

python manage.py grpcrunserver

Todo

  • support async
  • more interceptors

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

History

0.1.0 (2020-02-11)

  • First release on PyPI.

0.2.0 (2020-02-23)

  • Add tests and docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-grpc-framework, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size django_grpc_framework-0.3.0-py2.py3-none-any.whl (21.4 kB) File type Wheel Python version 3.7 Upload date Hashes View
Filename, size django-grpc-framework-0.3.0.tar.gz (16.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page