A fast, user friendly ORM and query builder which supports asyncio.
Project description
Piccolo is a fast, user friendly ORM and query builder which supports asyncio. Read the docs.
Features
Some of it’s stand out features are:
- Support for sync and async.
- A builtin playground, which makes learning a breeze.
- Tab completion support - works great with iPython and VSCode.
- Batteries included - a User model, authentication, migrations, an admin GUI, and more.
- Modern Python - fully type annotated.
- Make your codebase modular and scalable with Piccolo apps (similar to Django apps).
Syntax
The syntax is clean and expressive.
You can use it as a query builder:
# Select:
await Band.select(
Band.name
).where(
Band.popularity > 100
)
# Join:
await Band.select(
Band.name,
Band.manager.name
)
# Delete:
await Band.delete().where(
Band.popularity < 1000
)
# Update:
await Band.update({Band.popularity: 10000}).where(
Band.name == 'Pythonistas'
)
Or like a typical ORM:
# To create a new object:
b = Band(name='C-Sharps', popularity=100)
await b.save()
# To fetch an object from the database, and update it:
b = await Band.objects().get(Band.name == 'Pythonistas')
b.popularity = 10000
await b.save()
# To delete:
await b.remove()
Installation
Installing with PostgreSQL driver:
pip install 'piccolo[postgres]'
Installing with SQLite driver:
pip install 'piccolo[sqlite]'
Installing with all optional dependencies (easiest):
pip install 'piccolo[all]'
Building a web app?
Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM:
piccolo asgi new
Starlette, FastAPI, BlackSheep, Litestar, Esmerald and Lilya are currently supported.
Are you a Django user?
We have a handy page which shows the equivalent of common Django queries in Piccolo.
Documentation
Our documentation is on Read the docs.
We also have some great tutorial videos on YouTube.
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
Built Distribution
File details
Details for the file piccolo-1.12.0.tar.gz.
File metadata
- Download URL: piccolo-1.12.0.tar.gz
- Upload date:
- Size: 269.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/43.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.4 importlib-metadata/7.1.0 keyring/25.2.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ce7b791727ffc2a234efc86708f5b049cebe8af431cb99c8e18c0bfed5e26fd |
|
| MD5 | cd5d91a833672f102bb1ad1ec5137115 |
|
| BLAKE2b-256 | 608db51775d5e975a7a5499d17021c8f6f414b12c3bcf99f1970a111a9b5715a |
File details
Details for the file piccolo-1.12.0-py3-none-any.whl.
File metadata
- Download URL: piccolo-1.12.0-py3-none-any.whl
- Upload date:
- Size: 383.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/43.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.4 importlib-metadata/7.1.0 keyring/25.2.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4830e56892f8d4db38f92629ccad568ab8119ad9b457f114556422d241c2415c |
|
| MD5 | 922e4c0cf5dc00170ee2f0d610530cf1 |
|
| BLAKE2b-256 | eadc927b8308c2d8fa9f63b3a3ad6f3e9465a7074435f3f0f24362c7ac283f5c |
