Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrewthetechie/pydantic-aioredis

A Declarative ORM for Redis using Pydantic Models and aioredis
https://github.com/andrewthetechie/pydantic-aioredis

aioredis asyncio hacktoberfest pydantic python3

Last synced: 3 months ago
JSON representation

A Declarative ORM for Redis using Pydantic Models and aioredis

Host: GitHub
URL: https://github.com/andrewthetechie/pydantic-aioredis
Owner: andrewthetechie
License: other
Fork: true (sopherapps/pydantic-redis)
Created: 2021-08-06T19:12:00.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-27T19:29:02.000Z (7 months ago)
Last Synced: 2024-05-28T05:03:07.402Z (7 months ago)
Topics: aioredis, asyncio, hacktoberfest, pydantic, python3
Language: Python
Homepage:
Size: 1.99 MB
Stars: 52
Watchers: 2
Forks: 4
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst

Awesome Lists containing this project

awesome-pydantic - pydantic-aioredis - A simple Declarative ORM for Redis using Pydantic Models and aioredis (Object Mapping)
awesome-pydantic - pydantic-aioredis - A simple Declarative ORM for Redis using Pydantic Models and aioredis (Object Mapping)

README

        # pydantic-aioredis

Pydantic-aioredis is designed to provide an efficient way of integrating Redis databases with Python-based applications. Built on top of [Pydantic](https://docs.pydantic.dev/), pydantic-aioredis allows you to define data models and validate input data before it is stored in Redis. Data is validated before storing and after retrieval from Redis. The library also provides an easy-to-use API for querying, updating, and deleting data stored in Redis.

Inspired by

[pydantic-redis](https://github.com/sopherapps/pydantic-redis) by

[Martin Ahindura](https://github.com/Tinitto)



    

        

    

    

    

    


    

    

    

    


    

        

    

    



## Main Dependencies

- [Python +3.7](https://www.python.org)

- [redis-py <4.2.0](https://github.com/redis/redis-py)

- [pydantic](https://github.com/samuelcolvin/pydantic/)

## Getting Started

### Examples

Examples are in the [examples/](./examples) directory of this repo.

### Installation

Install the package

    pip install pydantic-aioredis

### Quick Usage

Import the `Store`, the `RedisConfig` and the `Model` classes and use accordingly

```python

import asyncio

from datetime import date

from pydantic_aioredis import RedisConfig, Model, Store

# Create models as you would create pydantic models i.e. using typings

class Book(Model):

    _primary_key_field: str = 'title'

    title: str

    author: str

    published_on: date

    in_stock: bool = True

# Do note that there is no concept of relationships here

class Library(Model):

    # the _primary_key_field is mandatory

    _primary_key_field: str = 'name'

    name: str

    address: str

# Create the store and register your models

store = Store(name='some_name', redis_config=RedisConfig(db=5, host='localhost', port=6379), life_span_in_seconds=3600)

store.register_model(Book)

store.register_model(Library)

# Sample books. You can create as many as you wish anywhere in the code

books = [

    Book(title="Oliver Twist", author='Charles Dickens', published_on=date(year=1215, month=4, day=4),

        in_stock=False),

    Book(title="Great Expectations", author='Charles Dickens', published_on=date(year=1220, month=4, day=4)),

    Book(title="Jane Eyre", author='Charles Dickens', published_on=date(year=1225, month=6, day=4), in_stock=False),

    Book(title="Wuthering Heights", author='Jane Austen', published_on=date(year=1600, month=4, day=4)),

]

# Some library objects

libraries = [

    Library(name="The Grand Library", address="Kinogozi, Hoima, Uganda"),

    Library(name="Christian Library", address="Buhimba, Hoima, Uganda")

]

async def work_with_orm():

  # Insert them into redis

  await Book.insert(books)

  await Library.insert(libraries)

  # Select all books to view them. A list of Model instances will be returned

  all_books = await Book.select()

  print(all_books) # Will print [Book(title="Oliver Twist", author="Charles Dickens", published_on=date(year=1215, month=4, day=4), in_stock=False), Book(...]

  # Or select some of the books

  some_books = await Book.select(ids=["Oliver Twist", "Jane Eyre"])

  print(some_books) # Will return only those two books

  # Or select some of the columns. THIS RETURNS DICTIONARIES not MODEL Instances

  # The Dictionaries have values in string form so you might need to do some extra work

  books_with_few_fields = await Book.select(columns=["author", "in_stock"])

  print(books_with_few_fields) # Will print [{"author": "'Charles Dickens", "in_stock": "True"},...]

  this_book = Book(title="Moby Dick", author='Herman Melvill', published_on=date(year=1851, month=10, day=17))

  await Book.insert(this_book)

  # oops, there was a typo. Fix it

  # Update is an async context manager and will update redis with all changes in one operations

  async with this_book.update():

    this_book.author = "Herman Melville"

    this_book.published_on=date(year=1851, month=10, day=18)

  this_book_from_redis = await Book.select(ids=["Moby Dick"])

  assert this_book_from_redis[0].author == "Herman Melville"

  assert this_book_from_redis[0].published_on == date(year=1851, month=10, day=18)

  # Delete any number of items

  await Library.delete(ids=["The Grand Library"])

# Now run these updates

loop = asyncio.get_event_loop()

loop.run_until_complete(work_with_orm())

```

### Custom Fields in Model

| Field Name          | Required | Default      | Description                                                          |

| ------------------- | -------- | ------------ | -------------------------------------------------------------------- |

| \_primary_key_field | Yes      | None         | The field of your model that is the primary key                      |

| \_redis_prefix      | No       | None         | If set, will be added to the beginning of the keys we store in redis |

| \_redis_separator   | No       | :            | Defaults to :, used to separate prefix, table_name, and primary_key  |

| \_table_name        | No       | cls.**name** | Defaults to the model's name, can set a custom name in redis         |

| \_auto_save         | No       | False        | Defaults to false. If true, will save to redis on instantiation      |

| \_auto_sync         | No       | False        | Defaults to false. If true, will save to redis on attr update        |

## License

Licensed under the [MIT License](./LICENSE)

## Contributing

Contributions are very welcome.

To learn more, see the [Contributor Guide](./CONTRIBUTING.rst)

### Contributors

Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_Andrew
💻 📖

      
_{Martin Ahindura}
💻 🤔

      
_{david-wahlstedt}
⚠️ 📖 👀

      
_{Daniel Wallace}
⚠️

      
_{Paco Nathan}
💡

      
_{Andreas Brodersen}
📖

      
_kraczak
📖

    

    

      
_{CharlieJiangXXX}
💻