Skip to main content

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

Project description

Piccolo

Tests Release Documentation Status PyPI Language grade: Python Total alerts codecov

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.

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
).run()

# Join:
await Band.select(
    Band.name,
    Band.manager.name
).run()

# Delete:
await Band.delete().where(
    Band.popularity < 1000
).run()

# Update:
await Band.update({Band.popularity: 10000}).where(
    Band.name == 'Pythonistas'
).run()

Or like a typical ORM:

# To create a new object:
b = Band(name='C-Sharps', popularity=100)
await b.save().run()

# To fetch an object from the database, and update it:
b = await Band.objects().where(Band.name == 'Pythonistas').first().run()
b.popularity = 10000
await b.save().run()

# To delete:
await b.remove().run()

Installation

Installing with PostgreSQL driver:

pip install 'piccolo[postgres]'

Installing with SQLite driver:

pip install 'piccolo[sqlite]'

Building a web app?

Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM:

piccolo asgi new

Starlette, FastAPI, and BlackSheep are currently supported.

Are you a Django user?

We have a handy page which shows the equivalent of common Django queries in Piccolo.

Documentation

See Read the docs.

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-0.33.0.tar.gz (126.6 kB view details)

Uploaded Source

Built Distribution

piccolo-0.33.0-py3-none-any.whl (210.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: piccolo-0.33.0.tar.gz
  • Upload date:
  • Size: 126.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.7.1 requests/2.26.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.11

File hashes

Hashes for piccolo-0.33.0.tar.gz
Algorithm Hash digest
SHA256 fba34bd777ddb0e1749c2b261309b4c3df2e276afb7bc21aa58b15a1c6320051
MD5 9726a78e4b4b71fc88f7f55cfd5ab8b1
BLAKE2b-256 373b7af6a250370cb670410535c634d0ef7480188831a5e574c09ed91ff8f0e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: piccolo-0.33.0-py3-none-any.whl
  • Upload date:
  • Size: 210.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.7.1 requests/2.26.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.11

File hashes

Hashes for piccolo-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64b080b900d5be617dce38c6cb30cefd7a320fa65f1b29ec7a8a7037bf695630
MD5 e13b2ef8c6430d6ea3c5d35b38444794
BLAKE2b-256 0ef2bbdd4159efeb9db793cf462a6a48f603164371b8a84dbfefaa2aa924fbe6

See more details on using hashes here.

Supported by

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