jkaufeld/spiderweb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 update readme

Browse Source
This commit is contained in:
Joe Kaufeld 2024-09-02 00:52:27 -04:00
parent b86036455a
commit 35e893e07e
1 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -43,6 +43,8 @@ if __name__ == "__main__":
app.start() app.start()
``` ```
## [View the docs here!](https://itsthejoker/github.io/spiderweb)
My goal with this framework was to do three things: My goal with this framework was to do three things:
1. Learn a lot 1. Learn a lot
@ -51,31 +53,28 @@ My goal with this framework was to do three things:
And, honestly, I think I got there. Here's a non-exhaustive list of things this can do: And, honestly, I think I got there. Here's a non-exhaustive list of things this can do:
* Function-based views - Function-based views
* Optional Flask-style URL routing - Optional Flask-style URL routing
* Optional Django-style URL routing - Optional Django-style URL routing
* URLs with variables in them a lá Django - URLs with variables in them a lá Django
* Gunicorn support - Full middleware implementation
* Full middleware implementation - Limit routes by HTTP verbs
* Limit routes by HTTP verbs - Custom error routes
* Custom error routes - Built-in dev server
* Built-in dev server - Gunicorn support
* HTML templates with Jinja2 - HTML templates with Jinja2
* Static files support - Static files support
* Cookies (reading and setting) - Cookies (reading and setting)
* Optional append_slash (with automatic redirects!) - Optional append_slash (with automatic redirects!)
* ~~CSRF middleware implementation~~ (it's there, but it's crappy and unsafe. I'm working on it.) - CSRF middleware
* Optional POST data validation middleware with Pydantic - CORS middleware
* Database support (using Peewee, but the end user can use whatever they want as long as there's a Peewee driver for it) - Optional POST data validation middleware with Pydantic
* Session middleware - Session middleware with built-in session store
- Database support (using Peewee, but you can use whatever you want as long as there's a Peewee driver for it)
The TODO list: - Tests (currently a little over 80% coverage)
* Tests (important)
* Fix CSRF middleware
Once tests are in and proven to work, then I'll release as version 1.0. Once tests are in and proven to work, then I'll release as version 1.0.
More documentation to follow! - currently missing tests for cors middleware
If you're reading this on GitHub, this repository is a public mirror of https://git.joekaufeld.com/jkaufeld/spiderweb. If you're reading this on GitHub, this repository is a public mirror of https://git.joekaufeld.com/jkaufeld/spiderweb.