Python License Status

A powerful, async-first ORM framework for modern Python applications

EarnORM is a modern, async-first Object-Relational Mapping (ORM) framework designed to provide a flexible and type-safe interface for database operations in Python applications. Built with performance and developer experience in mind, it offers seamless integration with multiple databases and modern Python features.

Currently in Alpha stage. Core features are implemented and working, but the API may change as we gather feedback and improve the framework.

• Core ORM functionality
• MongoDB support
• Connection pooling
• Type safety
• PostgreSQL support (in progress)
• MySQL support (planned)
• Migration system (planned)
• Admin interface (planned)

• 🔄 Async/Await First: Built from the ground up for asynchronous operations
• 🔒 Type Safety: Full type hints support with runtime validation
• 🎯 Multiple Database Support: MongoDB, PostgreSQL (coming soon), MySQL (planned)
• 🌟 Modern Python: Leverages latest Python features and best practices
• 🛠️ Developer Friendly: Intuitive API with excellent IDE support

• Async Operations

  • Non-blocking database operations
  • Async connection pooling
  • Event-driven architecture

• Type System

  • Runtime type checking
  • Custom type converters
  • Validation framework

• Connection Management

  • Smart connection pooling
  • Automatic recovery
  • Health monitoring

• Model System

  • Declarative models
  • Field validation
  • Relationship management
  • Event hooks

• Query Building

  • Type-safe queries
  • Complex filters
  • Aggregations
  • Joins

• Transaction Support

  • ACID compliance
  • Nested transactions
  • Savepoints
  • Automatic rollback

• Getting Started
• User Guide
• API Reference
• Contributing Guide

from earnorm.base import BaseModel
from earnorm.fields import StringField, IntegerField
class User(BaseModel):
 _name = 'data.user'
 name = StringField(required=True)
 age = IntegerField()
 async def validate(self):
 if self.age < 0:
 raise ValueError("Age cannot be negative")
# Create record
user = await User.create({
 "name": "John Doe",
 "age": 30
})
# Query records
users = await User.search([
 ("age", ">=", 18),
 ("name", "like", "John%")
])

from fastapi import FastAPI
from earnorm.config import SystemConfig
from earnorm.di import container
app = FastAPI()
@app.on_event("startup")
async def startup():
 # Load config
 config = SystemConfig.load_env(".env")
 
 # Initialize container
 await container.init(config)
 
 # Register services
 container.register("config", config)
@app.on_event("shutdown")
async def shutdown():
 await container.destroy()
@app.get("/users/{user_id}")
async def get_user(user_id: str):
 User = await container.get_model("data.user")
 return await User.read(user_id)

from django.apps import AppConfig
from earnorm.config import SystemConfig
from earnorm.di import container
class MyAppConfig(AppConfig):
 name = 'myapp'
 
 async def ready(self):
 # Initialize EarnORM
 config = SystemConfig.load_env(".env")
 await container.init(config)

from flask import Flask
from earnorm.config import SystemConfig
from earnorm.di import container
app = Flask(__name__)
@app.before_first_request
async def init_earnorm():
 config = SystemConfig.load_env(".env")
 await container.init(config)
@app.teardown_appcontext
async def shutdown_earnorm(exception=None):
 await container.destroy()

We welcome contributions! Please see our Contributing Guide for details.

1. Fork the repository
2. Create your feature branch
3. Add tests for new features
4. Submit a pull request

This project is licensed under the MIT License - see the LICENSE file for details.

• GitHub: @earnbase
• Email: contact@earnbase.io
• Twitter: @earnbase

EarnORM is built with inspiration from:

• Motor

Special thanks to all our contributors!