Morgan ORM for Python
A simple and easy-to-use ORM for managing your database queries.
Motivation
I decided to create an ORM for two main reasons:
- To build an ORM that is extremely simple to use, without complex configurations—just set up your database access and you're ready to go.
- As a learning experience to understand how an ORM works internally.
I've worked with Laravel for many years, so in a way, I'm drawing inspiration from Eloquent for this ORM.
Usage
Using the query builder from a model
Creating a model
# Import required packages
from morgan.connection import DatabaseConfig, ConnectionType
from morgan.orm import Model
# Create your model inheriting from Model
class User(Model):
table = "users" # Name of your table
primary_key = "id" # Name of your primary key
# Configuration for the database (now it only supports SQLite)
db_config = DatabaseConfig(connector=ConnectionType.SQLite, database_url="morgan.db")
Some available operations
# Get all the users
users = User.all()
# Get user by primary key
user = User.get_by_pk(pk=92)
# Get users by filtering results
users = User.where("status = ?", 1).get()
# Limiting results
users = User.where("status = ?", 1).limit(5).get()
# Ordering results
users = User.where("status = ?", 1).order_by("created_at", "DESC").get()
# Creating records
user = User.create_one(username="admin", email="admin@email.com", status=1)
# Or...
users_created = User.create_many([
{"username": "admin", "email": "admin@email.com", "status": 1},
{"username": "staff", "email": "staff@email.com", "status": 1},
{"username": "guest", "email": "guest@email.com", "status": 1},
])
# Updating records
User.where("status = ?", 0).update("status = ?", 1).exec()
# Deleting records
User.where("email = ?", "user@email.com").delete().exec()
Working with an instance
# Creating a new user
user = User(username="admin", email="admin@email.com", status=1)
user.save()
# Or...
user = User()
user.username = "admin"
user.email = "admin@email.com"
user.status = 1
user.save()
# Updating an existing record
user = User.get_by_pk(pk=8)
user.email = "support@email.com"
user.save()
# Deleting a record
user = User.get_by_pk(pk=9)
user.delete()
Roadmap
- Add support for methods such as
create_oneandcreate_manyin theQueryBuilder. - Add support for logging queries.
- Add unit tests.
- Add support for MySQL/MariaDB and PostgreSQL.
- Add support for statements like
GROUP BYandHAVING. - Add support for relationships such as one-to-one, one-to-many, and many-to-one.
Future plans include:
- Support for migrations.
- CLI tool for creating migrations and models files.
License
Metadata
Release files for py-morgan-orm 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| py_morgan_orm-0.2.0.tar.gz | 6.3 kB | Without provenance | Details for py_morgan_orm-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| py_morgan_orm-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for py_morgan_orm-0.2.0-py3-none-any.whl |
Total release size: 13.3 kB
Release files / py_morgan_orm-0.2.0.tar.gz
| Download URL | py_morgan_orm-0.2.0.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ca93791a015e3bcb6c9b523af76bca2f27b1ba40d3aac269fbe9133456e88210
|
|
BLAKE2b-256 checksum How to use checksums |
2b7201ad9aeb0f2fc682a15dd499c0bd6db91016438734e7f242a5a317bc0e61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Release files / py_morgan_orm-0.2.0-py3-none-any.whl
| Download URL | py_morgan_orm-0.2.0-py3-none-any.whl |
|---|---|
| Size | 7.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4edc94185b48d0f962b5527d24a71326a6a26ad59691c5b81800f0525deae9f9
|
|
BLAKE2b-256 checksum How to use checksums |
8856cce159133bfe27a002576b1c5055a12031afb27201f35c9d019d5f06bc2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Security for py-morgan-orm 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.