Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piccolo-orm/piccolo
A fast, user friendly ORM and query builder which supports asyncio.
https://github.com/piccolo-orm/piccolo
asgi asyncio database fastapi hacktoberfest orm piccolo postgresql python python3 query-builder sqlite starlette
Last synced: 28 days ago
JSON representation
A fast, user friendly ORM and query builder which supports asyncio.
- Host: GitHub
- URL: https://github.com/piccolo-orm/piccolo
- Owner: piccolo-orm
- License: mit
- Created: 2018-10-27T20:53:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T23:03:08.000Z (5 months ago)
- Last Synced: 2024-05-29T07:27:45.029Z (5 months ago)
- Topics: asgi, asyncio, database, fastapi, hacktoberfest, orm, piccolo, postgresql, python, python3, query-builder, sqlite, starlette
- Language: Python
- Homepage: https://piccolo-orm.com/
- Size: 3.93 MB
- Stars: 1,287
- Watchers: 15
- Forks: 85
- Open Issues: 133
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-fastapi - Piccolo - An async ORM and query builder, supporting Postgres and SQLite, with batteries (migrations, security, etc). (Third-Party Extensions / Databases)
- best-of-python - GitHub - 32% open · ⏱️ 03.06.2024): (Database Clients)
- awesome-litestar - Piccolo - An async ORM and query builder, supporting Postgres and SQLite, (Third-Party Extensions / Databases)
- awesome-asyncio - Piccolo - An ORM / query builder which can work in async and sync modes, with a nice admin GUI, and ASGI middleware. (Database Drivers)
- awesome-fastapi - Piccolo - An async ORM and query builder, supporting Postgres and SQLite, with batteries (migrations, security, etc). (Third-Party Extensions / Databases)
- awesome-pydantic - Piccolo - An async query builder and ORM, which can auto generate Pydantic models from database tables. (Object Mapping)
- awesome-pydantic - Piccolo - An async query builder and ORM, which can auto generate Pydantic models from database tables. (Object Mapping)
README
[](https://piccolo-orm.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/piccolo/)
[](https://codecov.io/gh/piccolo-orm/piccolo)
Piccolo is a fast, user friendly ORM and query builder which supports asyncio. [Read the docs](https://piccolo-orm.readthedocs.io/en/latest/).
## 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](https://github.com/piccolo-orm/piccolo_admin), 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:
```python
# 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:
```python
# 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:
```bash
pip install 'piccolo[postgres]'
```
Installing with SQLite driver:
```bash
pip install 'piccolo[sqlite]'
```
Installing with all optional dependencies (easiest):
```bash
pip install 'piccolo[all]'
```
## Building a web app?
Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM:
```bash
piccolo asgi new
```
[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/) and [Lilya](https://lilya.dev) are currently supported.
## Are you a Django user?
We have a handy page which shows the equivalent of [common Django queries in Piccolo](https://piccolo-orm.readthedocs.io/en/latest/piccolo/query_types/django_comparison.html).
## Documentation
Our documentation is on [Read the docs](https://piccolo-orm.readthedocs.io/en/latest/piccolo/getting_started/index.html).
We also have some great [tutorial videos on YouTube](https://www.youtube.com/channel/UCE7x5nm1Iy9KDfXPNrNQ5lA).