MoP

Features

Installation

pip install moss-mop

uv add moss-mop

Requirements

Project Structure

mop/
├── conf/ # Configuration management
├── db/ # Database connections
├── entity/ # Base entity class
├── error/ # Error handling
├── logging/ # Logging configuration
├── response/ # Response formatting
├── crud/ # CRUD operations
├── util/ # Utility functions
└── snowflake.py # Snowflake ID generation

Quick Start

1. Configuration

from mop.conf import settings
# Access configuration settings
print(settings.APP_NAME)
print(settings.DATABASE_URL)

2. Database Setup

from mop.db import session, async_session
from sqlalchemy import select
from your_model import User
# Synchronous session
with session() as db:
 users = db.execute(select(User)).scalars().all()
 print(users)
# Asynchronous session
async with async_session() as db:
 users = await db.execute(select(User))
 users = users.scalars().all()
 print(users)

3. Creating Models

from mop.entity import Entity
from sqlalchemy import Column, String
class User(Entity):
 __tablename__ = "users"
 username = Column(String(50), unique=True, index=True)
 email = Column(String(100), unique=True, index=True)

4. Error Handling

from mop.error import BusinessError, ErrCode
# Raise business error
raise BusinessError(ErrCode.USER_NOT_FOUND, "User not found")

5. Logging

from mop.logging import logger
# Log messages
logger.info("User logged in", user_id=123)
logger.error("Failed to process request", error="Invalid input")

6. Response Formatting

from mop.response import Response, PageResponse
from fastapi import FastAPI
app = FastAPI()
@app.get("/users")
async def get_users():
 users = [{"id": 1, "name": "John"}, {"id": 2, "name": "Jane"}]
 return Response(data=users, message="Success")
@app.get("/users/page")
async def get_users_page():
 users = [{"id": 1, "name": "John"}, {"id": 2, "name": "Jane"}]
 return PageResponse(data=users, total=100, page=1, page_size=20)

7. CRUD Operations

from mop.crud import CRUDBase
from your_model import User, UserCreate, UserUpdate
# Create CRUD instance
user_crud = CRUDBase(User)
# Create user
user = user_crud.create(db, obj_in=UserCreate(username="test", email="test@example.com"))
# Get user by ID
user = user_crud.get(db, id=1)
# Update user
user = user_crud.update(db, db_obj=user, obj_in=UserUpdate(email="new@example.com"))
# Delete user
user_crud.remove(db, id=1)
# Get users with pagination
users, total = user_crud.get_multi(db, page=1, page_size=10)

8. Snowflake ID Generation

from mop.snowflake import SnowflakeGenerator
# Create generator instance
generator = SnowflakeGenerator(datacenter_id=1, worker_id=1)
# Generate unique ID
unique_id = generator.generate()
print(unique_id)

Utilities

Date Utilities

from mop.util.dates import format_datetime, parse_datetime
# Format datetime
formatted = format_datetime(datetime.now())
print(formatted)
# Parse datetime
parsed = parse_datetime("2023-01-01 12:00:00")
print(parsed)

String Utilities

from mop.util.strings import random_string, is_email_valid
# Generate random string
rand_str = random_string(10)
print(rand_str)
# Check if email is valid
is_valid = is_email_valid("test@example.com")
print(is_valid)

File Utilities

from mop.util.files import read_file, write_file
# Read file
content = read_file("test.txt")
print(content)
# Write file
write_file("test.txt", "Hello, World!")

Changelog

Version 0.1.2 (2026年04月15日)

Fixed

Version 0.1.1 (2026年04月09日)

Changed

Version 0.1.0 (2025年12月15日)

Added

Contributing

License

Author

GitHub