inspira 0.0.1

Inspira is a lightweight framework for building asynchronous web applications.

Inspira

Inspira is a lightweight framework for building asynchronous web applications.

Quick Start

Prerequisites

Make sure you have Python and pip installed on your system.

Create a Python Virtual Environment

# Create a new directory for your project
mkdir myproject
cd myproject

Create and activate a virtual environment

python -m venv venv
source venv/bin/activate   # On Windows, use `venv\Scripts\activate`

Install Inspira

pip install inspira

Generating an App

To generate a new app for your project, run the following command:

inspira init

Generate Database file

Use the following command to generate a database file:

inspira new database --name mydb --type sqlite

This command will create a new database file named mydb with SQLite as the database type.

The generated database file (database.py) will typically contain initial configurations and may look like this:

from sqlalchemy import create_engine
from sqlalchemy.orm import declarative_base, scoped_session, sessionmaker

engine = create_engine("sqlite:///mydb.db")
db_session = scoped_session(
    sessionmaker(autocommit=False, autoflush=False, bind=engine)
)
Base = declarative_base()
Base.query = db_session.query_property()


def init_db():
    Base.metadata.create_all(bind=engine)

Generating Modules

To generate necessary resources for your project, run the following command:

inspira new module orders

Generated Directory Structure

After running the command to generate a new module (inspira new module orders), the directory structure of your project should look like the following:

├── app.py
├── database.py
└── src
    └── orders
        ├── __init__.py
        ├── order.py
        ├── order_controller.py
        └── order_repository.py
        └── order_service.py

Starting the Server

After generating your app and setting up the necessary resources, start the server with the following command:

uvicorn app:app --reload

Sessions

Inside app.py, after initializing Inspira instance:

app.session_type = "cookie"

Example 1: Setting a Session

@get("/")
async def set_session_data(request):
    context = {"variable": "value"}
    request.set_session("key", 23)

    return JsonResponse(context)

Example 2: Retrieving Session Data

@get("/")
async def get_session_data(request):
    context = {"variable": "value"}
    request.get_session("key")

    return JsonResponse(context)

Example 3: Removing Session Data

@get("/")
async def remove_session_data(request):
    context = {"variable": "value"}
    request.remove_session("key")

    return JsonResponse(context)

License

This project is licensed under the terms of the MIT license.