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:

├── main.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 main: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.10.0.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

inspira-0.10.0-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for inspira-0.10.0.tar.gz
Algorithm Hash digest
SHA256 19f2ec9598ff667fedcc0915aed0e960c1534c2221967a764858e025d1ab3cc0
MD5 0f22abe2efd9ea265f6a30305aea20b7
BLAKE2b-256 d64a3ea88c020c9dfeff99c12473ff2b171466096564df721170d60afc0a0769

See more details on using hashes here.

File details

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

File metadata

  • Download URL: inspira-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 33.6 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14838433216e7551de22953e4f5d3c07f7f1e7d457ab745c82f3b0ace8422ccf
MD5 1dfbd4254183f83c669d36acce566975
BLAKE2b-256 d4cbb7e1fdb6280b439f24f3e92072a79ccdffbe10dc0f4c5276b8ca2274a175

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