Salyam: Python Web Framework built for learning purposes

Salyam 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 Salyam

How to use it

Basic usage:

from salyam.core import Salyam

app = Salyam()


@app.route("/home", allowed_methods=["get"])
def home(request, response):
    response.text = "Hello from the HOME page"


@app.route("/hello/{name}", allowed_methods=["get", "post"])
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": "Salyam", "title": "Best Framework"}).encode()

ORM:

from salyam.db import Database, Table, Column, ForeignKey


# models
class Author(Table):
    name = Column(str)
    age = Column(int)


class Book(Table):
    title = Column(str)
    published = Column(bool)
    author = ForeignKey(Author)


db = Database("./test.db")

db.create(Author)
db.create(Book)

greg = Author(name="George", age=13)
db.save(greg)

authors = db.all(Author)

author = db.get(Author, 47)

book = Book(title="Building an ORM", published=True, author=greg)
db.save(book)

book.title = "How to build an ORM"
db.update(book)

db.delete(Book, id=book.id)

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 Salyam. The first one is app which is an instance of the main Salyam 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 Salyam() class:

app = Salyam(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 = Salyam(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 salyam.middleware.Middleware class and overriding its two methods that are called before and after each request:

from salyam.core import Salyam
from salyam.middleware import Middleware


app = Salyam()


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)