Skip to main content

Inspira is a lightweight framework for building asynchronous web applications.

Project description

Inspira

License

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

Links

Documentation: https://www.inspiraframework.com/

License

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

Download files

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

Source Distribution

inspira-0.0.3.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

inspira-0.0.3-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file inspira-0.0.3.tar.gz.

File metadata

  • Download URL: inspira-0.0.3.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for inspira-0.0.3.tar.gz
Algorithm Hash digest
SHA256 56b39658022b14e0f4520b3cb812c389fe4e43853fb8bbe82d8566a054d110b2
MD5 19e9e5c4c2aa382f3f362bd229130162
BLAKE2b-256 cb868128ea8cf256a3d55c4fcf6665dd32288c51a29c1ddeb811ed6fb21248f5

See more details on using hashes here.

File details

Details for the file inspira-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: inspira-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for inspira-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 858d2c2f475d911a54dd7e9b34a22760c65bde5dac86583fedb0bdf96dd2291a
MD5 a3bd823af8beacd05b4d4c8ae255216d
BLAKE2b-256 782e0d2171299dc5b5f6dfdd4ffdf4fd9806b32bb1e715bcfaf05dfa45a2cd67

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page