Trivela Python Web Framework build for learning purpose.

Project description

Trivela: Python Web Framework built for learning purposes

purpose PyPI

Trivela is a Python web framework build for learning purposes.

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

Installation

pip install trivela

How to use it

Basic usage:

from trivela.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": "Trivela", "title": "Worst 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 Trivela. 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": "Bad 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 trivela.middleware.Middleware class and overriding its two methods that are called before and after each request:

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

ORM

You can use Trivela ORM to interact with database and perform some basic operations mentioned below:

Connect to the database:

from trivela.orm import Database
db = Database("./demo.db")

Defining tables:

from trivela.orm import Table, Column, ForeignKey

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

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

Creating tables:

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

Creating an instance and inserting a row in database:

david = Author(name='David', age=23)
db.save(david)

Fetching all rows from database:

authors = db.all(Author)

Fetching a specific row by Id:

author = db.get(Author, 100)

Saving an object with a foreign key reference:

book = Book(title="Hello world", published=True, author=david)
db.save(book)

Fetching an object with a foreign key:

print(db.get(Book, 100).author.name)

Updating an object:

book.title = "World Hello"
db.update(book)

Deleting an object:

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

Project details

Release history Release notifications | RSS feed

This version

0.0.5

Apr 17, 2024

0.0.4

Apr 3, 2024

0.0.1

Apr 3, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trivela-0.0.5.tar.gz (9.0 kB view details)

Uploaded Apr 17, 2024 Source

Built Distribution

trivela-0.0.5-py3-none-any.whl (7.5 kB view details)

Uploaded Apr 17, 2024 Python 3

File details

Details for the file trivela-0.0.5.tar.gz.

File metadata

Download URL: trivela-0.0.5.tar.gz
Upload date: Apr 17, 2024
Size: 9.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.0.0 CPython/3.12.0

File hashes

Hashes for trivela-0.0.5.tar.gz
Algorithm	Hash digest
SHA256	`163ba7d6fdb0eaac3fa826d49d72d4c0094b669c9a18c2d7b9dccc925e384acc`
MD5	`69cd5c48921e4b1783914a42f73f56f9`
BLAKE2b-256	`ab418607b59d7e8bbed136dd0ecec848e4d8322b6dcfe6c78b5ea3b6f7afa322`

See more details on using hashes here.

Provenance

File details

Details for the file trivela-0.0.5-py3-none-any.whl.

File metadata

Download URL: trivela-0.0.5-py3-none-any.whl
Upload date: Apr 17, 2024
Size: 7.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.0.0 CPython/3.12.0

File hashes

Hashes for trivela-0.0.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`489c7dbdb12fcc792acc67379511fd7b1d1b8199e424bb61b868452e368e3bd0`
MD5	`5349e9a30327b4742eba149b324a306e`
BLAKE2b-256	`111ff73a686bce9fc3a5ac3af04b764f2b9f9150321cb1118cb41821974b48c6`