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://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.

Source Distribution

django-grpc-framework-0.2.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

django_grpc_framework-0.2.0-py2.py3-none-any.whl (20.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-grpc-framework-0.2.0.tar.gz.

File metadata

File hashes

Hashes for django-grpc-framework-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9548215b02f42622b51f3b98d7a4f7eec92aed9c2808273660f760819dcc32cc
MD5 f1f11a81dcc613638c9818ec5b448ece
BLAKE2b-256 4349a771e03762ee21adcea8a5a4c49c5ac519854a849acca44fd911cf477f46

See more details on using hashes here.

File details

Details for the file django_grpc_framework-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_grpc_framework-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3388436983affa7bceaeacbcecdb9d122faa56a4c8db9854212c813caf1f5413
MD5 7c5215a9b42bbd9abc6d1aba3ab41028
BLAKE2b-256 15b0b2e3bf7df13a952e47e428b8d235cdb34e88c91d228788093f78ea340703

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page