Skip to main content

The NOT ORM hydrator

Project description

Mayim

The NOT ORM Python hydrator

What is Mayim?

The simplest way to describe it would be to call it a one-way ORM. That is to say that it does not craft SQL statements for you. Think of it as BYOQ (Bring Your Own Query).

Why?

I have nothing against ORMs, truthfully. They serve a great purpose and can be the right tool for the job in many situations. I just prefer not to use them where possible. Instead, I would rather have control of my SQL statements.

The typical tradeoff though is that there is more work needed to hydrate from SQL queries to objects. Mayim aims to solve that.

Getting Started

pip install mayim[postgres]
import asyncio
from typing import List
from mayim import Mayim, PostgresExecutor, sql
from dataclasses import dataclass

@dataclass
class Person:
    name: str

class PersonExecutor(PostgresExecutor):
    @sql("SELECT * FROM people LIMIT $limit OFFSET $offset")
    async def select_all_people(
        self, limit: int = 4, offset: int = 0
    ) -> List[Person]:
        ...

async def run():
    executor = PersonExecutor()
    Mayim(dsn="postgres://...")
    print(await executor.select_all_people())


asyncio.run(run())

Documentation

The docs: ahopkins.github.io/mayim

Framework support

Out of the box, Mayim comes with extensions to support Quart, Sanic, and Starlette applications. Checkout the docs for more info.

Project details


Download files

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

Source Distribution

mayim-1.2.0.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mayim-1.2.0-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

Details for the file mayim-1.2.0.tar.gz.

File metadata

  • Download URL: mayim-1.2.0.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mayim-1.2.0.tar.gz
Algorithm Hash digest
SHA256 316f23f083574f522bbe18f62061ffe9c23a04208793fe6be20790a1c2e12bf2
MD5 229fe81ad1e8ace4d2ca4bd4b83bee56
BLAKE2b-256 23b86d0c9a59799d4b5134074a096f5c267af58d160a57e9cf27fb5c966b074a

See more details on using hashes here.

File details

Details for the file mayim-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: mayim-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mayim-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d1f45483c838df1f06f9cc8eeef04b42ce02a5c57eafd666236d32345f53a96
MD5 c152f3708cbacfaccf579b2337bd8952
BLAKE2b-256 6c692c96a4656494e63163a9ec817975a98f8e417bf91b295cab1793f219a0a0

See more details on using hashes here.

Supported by

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