squeaky-pl/japronto

Better Documentations ?

Opened this issue · 8 comments

yunstanford commented

I can't find any documentation, README is not enough for a web framework. readthedoc can help you in some sense.

squeaky-pl commented

There is somehow narrative documentation by example in: https://github.com/squeaky-pl/japronto/tree/master/examples

  • 👍1
yunstanford commented

yeah, i'd like to have some documentations like http://aiohttp.readthedocs.io/en/stable/web.html, for example, request/response/server/client etc. that would be very helpful. With only the README, i don't know even how to use request object.

yunstanford commented

how can i get the query parameters from request obj ?

like, "http://0.0.0.0:8080/profile/?query_id=012345678"

squeaky-pl commented

This is exactly documented in the file I linked:

# Given a HTTP 1.1 `GET` request to `/basic?a=1` this would yield
# `method` set to `GET`, `path` set to `/basic`, `version` set to `1.1`
# `query_string` set to `a=1` and `query` set to `{'a': '1'}`.```
yunstanford commented

doc in comment is not very noticeable. why not use some auto-doc system ? that'll be very helpful.

Thanks for your reply.

squeaky-pl commented

This project is intended for speed enthusiasts, people who like plumbing, exprimenting and early adopters. Whatever you see is a proof of concept. There is no point in writing nice documentation at this point since I know I am gonna break all the APIs anyway. That's why I don't want to encourage people to use it. If you are looking for somehow stable documented framework then aiohttp indeed or Sanic is for you.

  • 👍3
cpersico commented

Hi, I've been playing with japronto and so far I'm having a great time experimenting. But I'm not yet clear on how to tackle application unit testing, I get it that it's still a proof of concept in many ways, but perhaps there's a recommended approach to testing?

Note: I've seen the integration tests but perhaps that's not what I need now, I'll currently digging deeper into that.