Skip to main content

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

Project description

Logo

Tests Release Documentation Status PyPI Language grade: Python Total alerts 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
).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().get(Band.name == 'Pythonistas').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]'

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, 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

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

Uploaded Source

Built Distribution

piccolo-0.61.1-py3-none-any.whl (277.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: piccolo-0.61.1.tar.gz
  • Upload date:
  • Size: 176.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.2.0 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for piccolo-0.61.1.tar.gz
Algorithm Hash digest
SHA256 5c72e09177bdda185a3353c7eec3b2a299f7590818c9544893b81d7050e1560e
MD5 da1dc0a513adab772e14b1b0fd8fb69a
BLAKE2b-256 4aa98d34b1d6082849a01b7f1f438bebe4f9a9e94b82a10edc50e90570c5511e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: piccolo-0.61.1-py3-none-any.whl
  • Upload date:
  • Size: 277.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.2.0 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for piccolo-0.61.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c2aeb756459ad63ea71753a4d234975a60b4f65140415ba25a752db009dcc3ed
MD5 6b6eeff01d2f21c112526faac46b832d
BLAKE2b-256 84e72cdc27596fb4967f3a64a67eedd72c31cc3ca09ef9a11fa0525195e33343

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