WebNyx is Simple Python Web Framework. It was built for learning purposes.
It's a WSGI framework and can be used with any WSGI application server such as Gunicorn.
pip install webnyxfrom webnyx.app import WebNyxApp
app = WebNyxApp()
@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={"title": "Home Page", "body": "Best Body"}
)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 WebNyx. The first one is app which is an instance of the main WebNyxApp class:
import pytest
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 test_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, test_client):
@app.route("/{name}")
def hello(req, resp, name):
resp.text = f"hey {name}"
assert test_client.get("http://testserver/matthew").text == "hey matthew"The default folder for templates is templates. You can change it when initializing the main WebNyxApp() class:
app = WebNyxApp(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.body = app.template(
"example.html", context={"title": "Awesome Framework", "body": "welcome to the future!"}
)Just like templates, the default folder for static files is static and you can override it:
app = WebNyxApp(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>You can create custom middleware classes by inheriting from the webnyx.middleware.Middleware class and overriding its two methods
that are called before and after each request:
from webnyx.app import WebNyxApp
from webnyx.middleware import BaseMiddleware
app = WebNyxApp()
class SimpleCustomMiddleware(BaseMiddleware):
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)