A small package for performing basic CRUD operations with sqlite via aiosqlite and pydantic
Project description
ardilla
Ardilla (pronounced ahr-dee-yah) means "SQuirreL" in spanish.
A very simple library to quickly add SQLite to your program. It leverages pydantic for data validation and modeling. It comes in sync (sqlite3) and async (aiosqlite) flavors.
install
Install directly from github Without asynchronous support
pip install git+https://github.com/chrisdewa/ardilla.git
With asynchronous support
pip install git+https://github.com/chrisdewa/ardilla.git#egg=ardilla[async]
How to use:
This section is greatly underdeveloped
from ardilla import Engine, Model, Crud
engine = Engine('db.sqlite3')
Crud.engine = engine
class User(Model):
id: int
name: str
age: int
user_crud: Crud[User] = Crud(User)
def main():
engine.setup() # creates tables
# get or none
user = user_crud.get_or_none(id=1)
# get or create
user2, was_created = user_crud.get_or_create(id=2, name='chris', age=35)
# save one
user3 = User(id=3, name='moni', age=35)
user_crud.save_one(user3)
# save many
user_crud.save_many(user, user2, user3)
# get many
users = user_crud.get_many(age=35)
Supported CRUD methods:
crud.get_or_none
Returns an object or Nonecrud.insert
Inserts a record, rises errors if there's a conflictcrud.insert_or_ignore
Inserts a record or silently ignores if it already existscrud.get_or_create
returns an tuple of the object and a bool, True if the object was newly createdcrud.get_all
equivalent toSELECT * FROM tablename
crud.get_many
returns all the objects that meet criteriacrud.save_one
upserts an objectcrud.save_many
upserts many objectscrud.delete_one
deletes one objectcrud.delete_many
deletes many objects
To-dos
- Docstring everything using Google format
- Add testing
- Add proper documentation
- propper as in a site with how to use
- Add a schema generator
- There should be a method to generate a table's schema off the pydantic model.
- Add a method somewhere to fetch relationships.
- Improve this readme
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ardilla-0.0.2a0.tar.gz
(9.9 kB
view hashes)
Built Distribution
ardilla-0.0.2a0-py3-none-any.whl
(10.8 kB
view hashes)
Close
Hashes for ardilla-0.0.2a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ebe5575e69a9c85d70148d1bacf2fd4f5793d3dd3f6e41148503e2d21a58202 |
|
MD5 | dc28784565c552e741e2ba48d4f0240b |
|
BLAKE2b-256 | c982c02c66efc605c04e3c2b646dd606fa6ea39194bd0692bf0b84b4683d5439 |