Feature/async example bibliography

[markdoerr]

@AMontagu and @legau,

I am currently finalizing our first example.

Here are the TODOs I have in mind:

• finishing the documentation (review generated content, nicer formatting)
• SearchFilters (if supported) ?
• full streaming example (@AMontagu, please help here)
• full async clients (@AMontagu, please help here)
• test filtering
• jupyter notebooks ? Should we continue with them ? (I like the combination of code and markdown documentation)
• unittests

Anything else, I forgot ? Please let me know, how you like the example ? Could we use it in the ReadTheDocs Documentation, to explain the concepts better (with references to this repo ?) I think it would make things a lot clearer.

[AMontagu]

Hello @markdoerr Some feedback before reading everything:

• Why the name bib mean ?
• As we recommend only async app as example can we remove the async world in it ?
• SearchFilters is supported
• full streaming example: https://github.com/socotecio/django-socio-grpc/blob/master/django_socio_grpc/tests/test_async_stream_in.py#L50 https://github.com/socotecio/django-socio-grpc/blob/master/django_socio_grpc/tests/fakeapp/services/stream_in_service.py#L29

You have both read/write or async for/ yied method that can be used for serveur and client both depending of need. Note that await stream_caller.done_writing() is only needed in test as server and client automatically close connection but test does not

• Full async client: there was an example in the repo of an async client. How can I help ? (see backend/client.py file that is removed)
• Okay to continue with jupyter notebook
• No need for unit test in example I think

[markdoerr]

Hello @AMontagu,

• Why the name bib mean ?

In some cases I abbreviated "Bibliography" by "bib" - I hope, only in long filenames or variable names.

• As we recommend only async app as example can we remove the async world in it ?

I agree :)

• SearchFilters is supported

Cool - then I prepare an example

• full streaming example: https://github.com/socotecio/django-socio-grpc/blob/master/django_socio_grpc/tests/test_async_stream_in.py#L50 https://github.com/socotecio/django-socio-grpc/blob/master/django_socio_grpc/tests/fakeapp/services/stream_in_service.py#L29

Thanks for the link, the hopefully simplifies life.

You have both read/write or async for/ yied method that can be used for serveur and client both depending of need. Note that await stream_caller.done_writing() is only needed in test as server and client automatically close connection but test does not

Thanks for the hint - I will keep it in mind :)

• Full async client: there was an example in the repo of an async client. How can I help ? (see backend/client.py file that is removed)

I kept the code in one example as a comment - to adopt it to the new model. I would be happy, if you could test it, when I am done (and provide me some feedback) - I will ping you again, thanks for

• Okay to continue with jupyter notebook

8)

• No need for unit test in example I think

we move this point then to version 2.0 ;)

[markdoerr]

Hi @AMontagu and @legau, I am almost complete with the example now (and I am glad, that everything is running ;). I will just add some filter/search examples tonight, but please feel free to have a look at the current state and add some suggestions, what we forgot to demonstrate of your framework (I think, there are still quite some features missing, but we have a basis now for extension).

[AMontagu]

This start to be a too big PR and almost all is good. I merge it and we can open issue or other MR for improvement

[markdoerr]

:+1: - it simplifies things, @AMontagu ... I will work on some of the points both of you raised in the next days...