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.

Source Distribution

django-grpc-framework-0.3.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

django_grpc_framework-0.3.0-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-grpc-framework-0.3.0.tar.gz
Algorithm Hash digest
SHA256 df09b29285f66b7f70d973a1cde5af3e2fa249070f2f932f498422dd9d05d02e
MD5 2f53cc93119c51dcca5874e0b1017949
BLAKE2b-256 82bba7850f089f34c7875b9efd81c0551c4c11f2b5b9861f26bc501775402c7f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_grpc_framework-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1c5d6eb05b1857993c2235b5ccbb23ca21b1daa32a5eedd85677176563a6ff7b
MD5 9de879579f66397abfdd0e430abaf354
BLAKE2b-256 d5038b6d113d318db198b730c984aa846289de13c064dc3cb82f1f97737f661a

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