Web-PyOctopus is a lightweight Python web framework designed for learning and experimentation, inspired by modern frameworks like Django and FastAPI.
Project description
Web-PyOctopus: Python Web Framework built for learning purposes
WebPyOctopus is a Python web framework built for learning purposes.
It's a WSGI framework and can be used with any WSGI application server such as Gunicorn.
Installation
pip install web-pyoctopus
How to use it
Basic usage:
from pyoctopus.api import OctopusAPI
app = OctopusAPI()
@app.route("/home")
def home(request, response):
response.text = "Hello from the HOME page"
@app.route("/hello/{name}")
def greeting(request, response, name):
response.text = f"Hello, {name}"
@app.route("/book")
class BooksResource:
def get(self, req, resp):
resp.text = "Books Page"
def post(self, req, resp):
resp.text = "Endpoint to create a book"
@app.route("/template")
def template_handler(req, resp):
resp.body = app.template(
"index.html", context={"name": "Web-PyOctopus", "title": "Best Framework"}).encode()
Unit Tests
The recommended way of writing unit tests is with pytest. There are two built in fixtures
that you may want to use when writing unit tests with Web-PyOctopus. The first one is app which is an instance of the main API class:
def test_route_overlap_throws_exception(app):
@app.route("/")
def home(req, resp):
resp.text = "Welcome Home."
with pytest.raises(AssertionError):
@app.route("/")
def home2(req, resp):
resp.text = "Welcome Home2."
The other one is client that you can use to send HTTP requests to your handlers. It is based on the famous requests and it should feel very familiar:
def test_parameterized_route(app, client):
@app.route("/{name}")
def hello(req, resp, name):
resp.text = f"hey {name}"
assert client.get("http://testserver/matthew").text == "hey matthew"
Templates
The default folder for templates is templates. You can change it when initializing the main API() class:
app = API(templates_dir="templates_dir_name")
Then you can use HTML files in that folder like so in a handler:
@app.route("/show/template")
def handler_with_template(req, resp):
resp.html = app.template(
"example.html", context={"title": "Awesome Framework", "body": "welcome to the future!"})
Static Files
Just like templates, the default folder for static files is static and you can override it:
app = API(static_dir="static_dir_name")
Then you can use the files inside this folder in HTML files:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>{{title}}</title>
<link href="/static/main.css" rel="stylesheet" type="text/css" />
</head>
<body>
<h1>{{body}}</h1>
<p>This is a paragraph</p>
</body>
</html>
Middleware
You can create custom middleware classes by inheriting from the web-pyoctopus.middleware.Middleware class and overriding its two methods
that are called before and after each request:
from pyoctopus.api import OctopusAPI
from pyoctopus.middleware import Middleware
app = OctopusAPI()
class SimpleCustomMiddleware(Middleware):
def process_request(self, req):
print("Before dispatch", req.url)
def process_response(self, req, res):
print("After dispatch", req.url)
app.add_middleware(SimpleCustomMiddleware)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file web-pyoctopus-0.0.3.tar.gz.
File metadata
- Download URL: web-pyoctopus-0.0.3.tar.gz
- Upload date:
- Size: 7.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc34f3ab0fc5ff8bcd77c888949e490bfc11a45df239751d6a4e1cc945f5131b
|
|
| MD5 |
3b63ddad0cb8f06a25df4b37689a92da
|
|
| BLAKE2b-256 |
2a0d554bc187dfea94c561493011124a56b7d64fdfa4ed0fed8908fff4e5ea4b
|
File details
Details for the file web_pyoctopus-0.0.3-py3-none-any.whl.
File metadata
- Download URL: web_pyoctopus-0.0.3-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b40a6b9a1c734a425962525597558c2233ba993a2dd60b19760cd13b3d6e09e2
|
|
| MD5 |
7c2557d28e768a8dc3e178daa213b8e4
|
|
| BLAKE2b-256 |
ee8602b4913f7cbdee0efa73941bed5f24fda54cc243dc81e23125e7faaacdef
|
