Skip to main content

Zyne: Python MVC Web Framework

purpose PyPI

Zyne is a Python MVC web framework built for agility.

It's a WSGI framework and can be used with any WSGI application server such as Gunicorn.

Installation

pip install zyne

How to use it

Basic usage:

from zyne.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("/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": "Zyne", "title": "A MVC Web 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 Zyne. 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 zyne.middleware.Middleware class and overriding its two methods that are called before and after each request:

from zyne.api import API
from zyne.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)

Metadata

Release files for zyne 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zyne 1.0.0
File Size Uploaded Provenance Actions
zyne-1.0.0.tar.gz 8.0 kB Without provenance Details for zyne-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zyne 1.0.0
File Interpreter ABI Platform Actions
zyne-1.0.0-py3-none-any.whl Python 3 none any Details for zyne-1.0.0-py3-none-any.whl

Total release size: 14.6 kB

Release files / zyne-1.0.0.tar.gz

Download URL zyne-1.0.0.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
24cbd2f1ef17c845d7a1fcc1947c21f0ef250d4119eaea3fa1b351acf6328b26
BLAKE2b-256 checksum
How to use checksums
cd92fb392badc903566a71e208cc69839e7f3cbb2c76d4b677cc372957524fea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Release files / zyne-1.0.0-py3-none-any.whl

Download URL zyne-1.0.0-py3-none-any.whl
Size 6.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
420b810d1b69d89a09e8ff4c30876fc38d0e8f1111cadab3df6e0731197cc4b9
BLAKE2b-256 checksum
How to use checksums
d21bc50fe2a7be819d4273c2d16878a51bda39921c4a7ba032bb15257b2a8cf5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Security for zyne 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page