README.md

Django Socio Grpc

Django Socio gRPC is a toolkit for building gRPC services, inspired by Django REST framework. It is based on django-grpc-framework and includes all the DRF features such as authentication, filtering, pagination, and more complex proto generation.

Documentation

The documentation can be found here.

Requirements

• Python (>= 3.10)
• Django (>=4.2), Django REST Framework (>=3.10)
• grpcio-tools (>=1.50.0)

Installation

Run the following command using pip:

    pip install django-socio-grpc

Then, add django_socio_grpc to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        ...
        'django_socio_grpc',
    ]

Local development & documentation

docker compose up

For local documentation go to http://localhost:6001

Launch tests

docker compose exec django-socio-grpc poetry run tests