https://github.com/ahopkins/mayim

The *NOT* ORM hydrator
https://github.com/ahopkins/mayim

asyncio hydrator orm postgres python

Last synced: about 1 month ago
JSON representation

The *NOT* ORM hydrator

• Host: GitHub
• URL: https://github.com/ahopkins/mayim
• Owner: ahopkins
• License: mit
• Created: 2022-05-19T08:50:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-21T02:48:26.000Z (10 months ago)
• Last Synced: 2024-11-09T20:04:51.642Z (about 2 months ago)
• Topics: asyncio, hydrator, orm, postgres, python
• Language: Python
• Homepage: https://ahopkins.github.io/mayim/
• Size: 458 KB
• Stars: 98
• Watchers: 7
• Forks: 8
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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]

```

```python

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](https://ahopkins.github.io/mayim/guide/)

## Framework support

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