PoridhiFrame Python Web Framework built for learning purposes.
Project description
PoridhiFrame: Python Web Framework built for learning purposes
PoridhiFrame is a Python web framework built for learning purposes. It demonstrates modern web framework architecture including middleware, routing, templating, and more.
It's a WSGI framework and can be used with any WSGI application server such as Gunicorn.
Installation
pip install poridhiframe
How to use it
Basic usage:
from poridhiframe.api import API
app = API()
@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("/books")
class BooksResource:
def get(self, req, resp):
resp.text = "Books Page"
def post(self, req, resp):
resp.text = "Endpoint to create a book"
Response Types
PoridhiFrame supports multiple response types with automatic content-type setting:
@app.route("/json")
def json_handler(req, resp):
resp.json = {"message": "Hello JSON"}
@app.route("/html")
def html_handler(req, resp):
resp.html = "<h1>Hello HTML</h1>"
@app.route("/text")
def text_handler(req, resp):
resp.text = "Hello Text"
HTTP Method Control
Restrict handlers to specific HTTP methods:
@app.route("/api/users", allowed_methods=["GET", "POST"])
def users_api(req, resp):
if req.method == "GET":
resp.json = {"users": ["Alice", "Bob"]}
elif req.method == "POST":
resp.json = {"message": "User created"}
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 poridhiframe.middleware.Middleware class and overriding its two methods that are called before and after each request:
from poridhiframe.api import API
from poridhiframe.middleware import Middleware
app = API()
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)
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 PoridhiFrame. 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 library:
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"
Running with WSGI Servers
Development Server (Python built-in)
# app.py
from poridhiframe.api import API
app = API()
@app.route("/")
def home(req, resp):
resp.text = "Hello World"
if __name__ == "__main__":
# Simple development server
from wsgiref.simple_server import make_server
server = make_server('localhost', 8000, app)
print("Server running on http://localhost:8000")
server.serve_forever()
Production Server (Gunicorn)
# Install gunicorn
pip install gunicorn
# Run your application
gunicorn app:app
Contributing
This framework was built for educational purposes. Feel free to fork, modify, and experiment with the code to learn more about web framework internals.
License
MIT License
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 poridhiframe1-0.0.2.tar.gz.
File metadata
- Download URL: poridhiframe1-0.0.2.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8b680d6d58e7c8a02de079f6cdc95219c09cbcf621a6f8fb13fc7a0df0c1d9e
|
|
| MD5 |
179719acb5d90d3ceafad88495913936
|
|
| BLAKE2b-256 |
37d656f98d664b5fbc1211187ddcbb06c09867edc612cf401c4b802f598a8c98
|
File details
Details for the file poridhiframe1-0.0.2-py3-none-any.whl.
File metadata
- Download URL: poridhiframe1-0.0.2-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40bd4dc72de088402f4b1e229ffdc9e34346026a0d0bdb5371d49b98af51c88c
|
|
| MD5 |
d01a31c4fd766093a1dfb0daa08e582e
|
|
| BLAKE2b-256 |
4cecd2ae07aeb898fe47f5da4abb8f588b3537bcf699c331324253574f859b6c
|
