README.md

ardilla

Ardilla (pronounced ahr-dee-yah) means "SQuirreL" in spanish.

This library aims to be a simple way to add an SQLite database and basic C.R.U.D. methods to python applications. It uses pydantic for data validation and supports a sync engine as well as an async (aiosqlite) version.

Who and what is this for

This library is well suited for developers seeking to incorporate SQLite into their python applications to use simple C.R.U.D. methods. It excels in its simplicity and ease of implementation while it may not be suitable for those who require more complex querying, intricate relationships or top performance.

For developers who desire more advanced features, there are other libraries available, such as tortoise-orm, sqlalchemy, pony or peewee.

Links

Find Ardilla's source code here

Documentation can be accessed here

install

Install lastest release from PyPi

pip install -U ardilla
pip install -U ardilla[async]
pip install -U ardilla[dev]

• async instaslls aiosqlite
• dev installs formatting and testing dependencies

Or install the lastest changes directly from github

pip install git+https://github.com/chrisdewa/ardilla.git
pip install git+https://github.com/chrisdewa/ardilla.git#egg=ardilla[async]
pip install git+https://github.com/chrisdewa/ardilla.git#egg=ardilla[dev]

How to use

from ardilla import Engine, Model, Crud
from pydantic import Field

class User(Model):
    id: int = Field(primary=True, autoincrement=True) 
    name: str
    age: int

def main():
    with Engine('db.sqlite') as engine:
      user = crud.get_or_none(id=1) # user with id of 1
      user2, was_created = crud.get_or_create(id=2, name='chris', age=35)
      users = crud.get_many(name='chris') # all users named chris
      user3 = User(id=3, name='moni', age=35)
      user.age += 1 # it's her birthday
      crud.save_one(user3)
      crud.save_many(user, user2, user3)

Supported CRUD methods:

• crud.insert Inserts a record, rises errors if there's a conflict
• crud.insert_or_ignore Inserts a record or silently ignores if it already exists
• crud.save_one upserts an object
• crud.save_many upserts many objects
• crud.get_all equivalent to SELECT * FROM tablename
• crud.get_many returns all the objects that meet criteria
• crud.get_or_create returns an tuple of the object and a bool, True if the object was newly created
• crud.get_or_none Returns the first object meeting criteria if any
• crud.delete_one Deletes an object
• crud.delete_many Deletes many objects

Examples:

• A simple FastAPI application
• A reputation based discord bot
• basic usage
• basic usage with foreign keys