https://github.com/psqlpy-python/psqlpy-piccolo

PSQLPy integration for Piccolo-ORM
https://github.com/psqlpy-python/psqlpy-piccolo

Last synced: 10 months ago
JSON representation

PSQLPy integration for Piccolo-ORM

• Host: GitHub
• URL: https://github.com/psqlpy-python/psqlpy-piccolo
• Owner: psqlpy-python
• Created: 2024-06-24T19:56:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-25T09:45:22.000Z (over 1 year ago)
• Last Synced: 2024-10-24T16:36:51.420Z (about 1 year ago)
• Language: Python
• Size: 241 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/psqlpy-piccolo?style=for-the-badge)](https://pypi.org/project/psqlpy-piccolo/)

# psqlpy-piccolo

This is a third-party Rust engine for [Piccolo ORM](https://github.com/piccolo-orm/piccolo).  

Under the hood, this engine uses [PSQLPy](https://github.com/qaspen-python/psqlpy), which is Rust-based and blazingly fast 🔥.

## Installation

You can install package with `pip` or `poetry`.

poetry:

```bash

$ poetry add psqlpy-piccolo

```

pip:

```bash

$ pip install psqlpy-piccolo

```

## Usage

Usage is as easy as possible.  

PSQLPy based engine has the same interface as other engines from piccolo.

```python

from psqlpy_piccolo import PSQLPyEngine

DB = PSQLPyEngine(

    config={

        "host": "127.0.0.1",

        "port": 5432,

        "user": "postgres",

        "password": "postgres",

        "database": "psqlpy-piccolo",

    },

)

```