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

Uploaded Source

Built Distribution

piccolo-0.40.1-py3-none-any.whl (224.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: piccolo-0.40.1.tar.gz
  • Upload date:
  • Size: 136.2 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.2 CPython/3.7.11

File hashes

Hashes for piccolo-0.40.1.tar.gz
Algorithm Hash digest
SHA256 8cea1cdcc66c7b80dea3e8c97960b2c6c9f380f5b92c6ccd7a0eac7d4499219b
MD5 f9f629ddf60f97002340e1f97b4d09a3
BLAKE2b-256 5f5bbfdcb6df478adc0159b23cdb1b5eb5685b9cd4e0fb99d1ef27c90b6f5522

See more details on using hashes here.

File details

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

File metadata

  • Download URL: piccolo-0.40.1-py3-none-any.whl
  • Upload date:
  • Size: 224.7 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.2 CPython/3.7.11

File hashes

Hashes for piccolo-0.40.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4f1e4ad62ee2312d968d40088efc83378065845c59698efd2e53248e67e0146
MD5 973bd96925fe3bc725487a0207120c1f
BLAKE2b-256 35dd3ce0acd1b999254db3b882c5442a82fc2ebc155cb1a3bf9808bf5ca3308d

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