pydough 1.0.0

Analytics DSL for Python

PyDough

PyDough is an alternative DSL that can be used to solve analytical problems by phrasing questions in terms of a logical document model instead of translating to relational SQL logic.

Learning About PyDough

Refer to these documents to learn how to use PyDough:

• Spec for the PyDough DSL
• Spec for the PyDough metadata
• List of builtin PyDough functions
• Usage guide for PyDough

Developing PyDough

PyDough uses uv as a package manager. Please refer to their docs for installation. To run testing commands after installing uv, run the following command:

uv run pytest <pytest_arguments>

If you want to skip tests that execute runtime results because they are slower, make sure to include -m "not slow" in the pytest arguments.

Note: That some tests may require an additional setup to run successfully. Please refer to the TPC-H demo directory for more information on how to setup a default database for testing.

Running CI Tests

To run our CI tests on your PR, you must include the flag [run CI] in latest commit message.

Runtime Dependencies

PyDough requires having the following Python modules installed to use the library:

• pytz, pandas, sqlglot

The full list of dependencies can be found in the pyproject.toml file.

Demo Notebooks

The demo folder contains a series of example Jupyter Notebooks that can be used to understand PyDough's capabilities. We recommend any new user start with the demo readme and then walk through the example Juypter notebooks.