pakal/django-socio-grpc

gRPC for Django.

Django Socio Grpc

Django Socio gRPC is a toolkit for building gRPC services, inspired by djangorestframework. It is base on django-grpc-framework with all the DRF features enable Auth, Filter, Pagination, more complex proto generation...

DOCUMENTATION

https://socotecio.github.io/django-socio-grpc/

Requirements

• Python (>= 3.6)
• Django (2.2, >=3.0), Django REST Framework (>=3.10)
• gRPC, gRPC tools, proto3

Installation

    pip install django-socio-grpc

Add django_socio_grpc to INSTALLED_APPS setting:

    INSTALLED_APPS = [
        ...
        'django_socio_grpc',
    ]

For more informations follow the quickstart: https://socotecio.github.io/django-socio-grpc/

Launch dev environnement

    docker compose up --build
    docker compose exec django-socio-grpc python test_utils/migrate.py
    docker compose exec django-socio-grpc poetry run tests
    # single test launch
    docker compose exec django-socio-grpc poetry run tests django_socio_grpc/tests/test_proto_generation.py

Regenerate proto used for unit test:

docker compose exec django-socio-grpc python test_utils/generateproto.py

Contribute to documentation

Launch in local:

docker compose exec django-socio-grpc mkdocs serve -a localhost:6001
# Or just docker compose up and navigate to localhost:6001

Deploy Documentation:

mkdocs gh-deploy -m "[ci skip] auto commit with MKDocs"