Fix #163: Some fixes in documentation and add auth example #166
Conversation
|
Thank you for you PR! I've been quite busy the last days but I will review this until sunday. |
There was a problem hiding this comment.
I'm really sorry I did not get back to you as promised. If that's an excuse, I moved to another continent and could not find the spare time before that, even though I thought I would!
I really appreciate having a working auth example. It's something a lot of users want to do and your work will help them tremendously.
I'd just want to fine-tune a few things before this will be merged in master:
-
requirements.txt. So far the other examples don't have their ownrequirements. As far as I can see, you only really need it for 'itsdangerous'. Do you think renaming the file toadditional-requirements.txtand just adding those is sufficient? People then would have to install the top-levelrequirements.txtin addition toadditional-requirements.txt. -
We should add an example how to "use" this example in the docs. E.g. add curl commands to show how to get 401 Unauthorized first, then how login to get the token and send a subsequent, successful request.
-
Maybe even "refactor" the docs to not have a lot of duplicated code, but use
literalincludeto include relevant parts of the example code. See http://www.sphinx-doc.org/en/stable/markup/code.html#directive-literalinclude .
| @@ -69,7 +69,7 @@ First we need to create eve-side authentication: | |||
| register_views(app) | |||
| app.run() | |||
|
|
|||
| Next step is the `User` SQLAlchemy model: | |||
| Next step is the `User` And `Role` SQLAlchemy model: | |||
| from models import Base, Role, User | ||
| from views import register_views | ||
|
|
||
| pymysql.install_as_MySQLdb() |
There was a problem hiding this comment.
Do we need to use pymysql here? The other examples use a in-memory SQLite database. Would that be sufficient here, too?
|
@amoyiki Did you close this by mistake? If you are not interested in adapting your code, let me know. I will do so and still merge it. |
|
@dkellner i want to fix this mistake in this week |
this is my first pr in github:)