https://github.com/PRQL/pyprql

Python extensions for PRQL
https://github.com/PRQL/pyprql

Last synced: 2 months ago
JSON representation

Python extensions for PRQL

• Host: GitHub
• URL: https://github.com/PRQL/pyprql
• Owner: PRQL
• License: apache-2.0
• Created: 2022-02-03T22:56:55.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T16:27:51.000Z (8 months ago)
• Last Synced: 2024-05-29T14:48:10.380Z (8 months ago)
• Language: Python
• Homepage: https://pyprql.readthedocs.io
• Size: 2.04 MB
• Stars: 89
• Watchers: 7
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# pyprql

[![CI/CD](https://github.com/prql/pyprql/actions/workflows/pull-request.yaml/badge.svg?branch=main)](https://github.com/prql/pyprql/actions/workflows/pull-request.yaml)

[![Documentation Status](https://readthedocs.org/projects/pyprql/badge/?version=latest)](https://pyprql.readthedocs.io/en/latest/?badge=latest)

![PyPI](https://img.shields.io/pypi/v/pyprql)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyprql)

[![Codestyle: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

pyprql contains:

- pyprql.pandas_accessor — Pandas integration for PRQL

- pyprql.polars_namespace — Polars integration for PRQL

- pyprql.magic — IPython magic for connecting to databases using `%%prql`

- pyprql.compile — An export of `prqlc`'s `compile` function

For docs, check out the [pyprql docs](https://pyprql.readthedocs.io/), and the

[PRQL Book][prql_docs].

## Installation

```sh

pip install pyprql

```

Or, install with optional dependencies:

```sh

pip install pyprql[polars]

```

## Usage

### Pandas integration

```python

import pandas as pd

import pyprql.pandas_accessor

df = (...)

results_df = df.prql.query("select {age, name, occupation} | filter age > 21")

```

### Polars integration

```python

import polars as pl

import pyprql.polars_namespace

df = (...)

results_df = df.prql.query("select {age, name, occupation} | filter age > 21")

```

### Jupyter Magic

```python

In [1]: %load_ext pyprql.magic

In [2]: %prql postgresql://user:password@localhost:5432/database

In [3]: %%prql

   ...: from p

   ...: group categoryID (

   ...:   aggregate {average unitPrice}

   ...: )

In [4]: %%prql results <<

   ...: from p

   ...: aggregate {min unitsInStock, max unitsInStock}

```

### Compilation

This library exposes `prqlc.compile`, so we can simply generate SQL:

```python

import pyprql

pyprql.compile("from artists | select track")

print(pyprql.compile("from artists | select track"))

```

...returns...

```sql

SELECT

  track

FROM

  artists

```

For context, `prqlc` in Python is the Python binding for the `prqlc` Rust crate, so only

contains functions for compilation; and this library offers broader python

integrations and tooling.

## Support

This project was created by

[@charlie-sanders](https://github.com/charlie-sanders/) &

[@rbpatt2019](https://github.com/rbpatt2019) and is now maintained by the

broader PRQL team.

[prql_docs]: https://prql-lang.org/book