Comments (14)
@dantownsend I'll do it in a few minutes.
from piccolo_api.
Excellent -- this is very helpful. Would it be possible also to give an example of how the CRSF token mechanism is supposed to work? Thanks
from piccolo_api.
@dantownsend Do you think of the whole app as in the Piccolo examples? If not your example from comment is perfect example of SessionAuth
and that should be in docs.
from piccolo_api.
@sinisaos The example code here might be sufficient.
I was thinking of a new page in the docs, with this code in it.
The example code is an abbreviated form of one of my own apps - I haven't actually tested it standalone, but it looks correct.
What I'd love is if we had a new folder in the repo called examples
. This file would be in there, and we'd somehow embed it within the docs.
I know Sphinx can be used to embed fragments of files, but I haven't tried embedding an entire file before.
At some point, we could add a unit test for the example app, to make sure it works.
from piccolo_api.
@dantownsend I have a question. I don't know anything about Sphinx's embed fragments of files, but I created a Piccolo Task starter app (based on your example) with SessionAuth
where openapi docs are private and the home page is public. Everything works great, but I donβt know if I need to push the app to my Github repo and then you can put a link in the Piccolo examples or what to do with it? Thanks in advance.
from piccolo_api.
@sinisaos I think it would be nice to embed the code directly in the docs.
I've figured out how to embed entire Python files:
Full example
============
.. include:: example.py
:code: python
from piccolo_api.
If you wanted to push your code to a new repo, I don't mind linking to it from the piccolo_examples
repo.
But I'd still like to embed an example in the Piccolo API docs.
from piccolo_api.
Thanks for checking the example code works.
from piccolo_api.
@dantownsend I made examples
folder in SessionAuth directory in docs and then embed with
Full example
============
.. include:: ./examples/example.py
:code: python
Result is:
Did you mean something like this or?
from piccolo_api.
@sinisaos That's right - but can we put the example in it's own page?
from piccolo_api.
@dantownsend Yes we can.
Index page
Full example page
from piccolo_api.
@sinisaos That's great, thanks
from piccolo_api.
If you open it as a PR, I'll get it merged.
from piccolo_api.
Fixed by #86
from piccolo_api.
Related Issues (20)
- Fix code scanning alert - Unused global variable
- Batch version of the get endpoint HOT 6
- Drop Python 3.7 support
- Catch foreign key constraint errors in `PiccoloCRUD`
- `schema_extra` param not passed to `pydantic_model_{output | optional | plural}` methods HOT 1
- Piccolo Admin API docs are not rendering
- Better error display on PATCH request
- Alpha version for Pydantic 2.0 / Piccolo 1.0a1? HOT 2
- PiccoloCRUD `post_single` return id of the inserted row instead of the row HOT 3
- Add `ne` operator
- Python 3.12 support
- RateLimitingMiddleware tests failed HOT 5
- Stop multi-dimensional arrays from breaking
- Issue with updating and bulk updating `BaseUser` via admin panel HOT 15
- Updating middleware syntax HOT 6
- Make `default-src` configurable in `CSPMiddleware`
- Hide parameter in Validators to hide Piccolo Admin table link from sidebar if the validators fail. HOT 8
- Add `excluded_paths` to `SessionsAuthBackend`
- Replace deprecated `abstractproperty`
- Fix for Pydantic breaking changes HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from piccolo_api.