Skip to main content

A fast, user friendly ORM and query builder which supports asyncio.

Project description

Logo

Tests Release Documentation Status PyPI codecov

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, Lilya, Quart, Falcon and Sanic 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.

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

piccolo-1.27.1.tar.gz (285.2 kB view details)

Uploaded Source

Built Distribution

piccolo-1.27.1-py3-none-any.whl (406.3 kB view details)

Uploaded Python 3

File details

Details for the file piccolo-1.27.1.tar.gz.

File metadata

  • Download URL: piccolo-1.27.1.tar.gz
  • Upload date:
  • Size: 285.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.1.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.4.0 tqdm/4.67.1 importlib-metadata/8.7.0 keyring/25.6.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.13.3

File hashes

Hashes for piccolo-1.27.1.tar.gz
Algorithm Hash digest
SHA256 5dbb332e420794517e9f61de4acb93d7ce1b0be4bbc8415d6c06a9f1f8d09cff
MD5 28522754640174cd207f412423f0348e
BLAKE2b-256 df1f1de8a08e7eb4e6e8e879e442a8eebc1e2887a79a19a43850aaff4bc4cdb6

See more details on using hashes here.

File details

Details for the file piccolo-1.27.1-py3-none-any.whl.

File metadata

  • Download URL: piccolo-1.27.1-py3-none-any.whl
  • Upload date:
  • Size: 406.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.1.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.4.0 tqdm/4.67.1 importlib-metadata/8.7.0 keyring/25.6.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.13.3

File hashes

Hashes for piccolo-1.27.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e3b9539e2e74d6e13b10709fbc7a1aca9b25a3d507b2cc07a06448f219ca8e5
MD5 f4f9be09e3d62eb945a1294978052e74
BLAKE2b-256 a02d2892ebf6a6965fbb63a7ddcddee439ed989e3355baacb360236efb1cfe0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page