Python
This page documents a preview version.
v2.23 Preview
Preview includes features under active development and is for development and testing only.
For production, use the latest stable version (v2024.1).
For production, use the latest stable version (v2024.1).
Supported projects
The following projects can be used to implement Python applications using the YugabyteDB YSQL API.
| Project | Documentation and Guides | Latest Driver Version | Supported YugabyteDB Version |
|---|---|---|---|
| Yugabyte Psycopg2 Smart Driver [Recommended] | Documentation Reference |
2.9.3 | 2.8 and above |
| PostgreSQL Psycopg2 Driver | Documentation Reference |
2.9.3 | 2.8 and above |
| aiopg | Documentation | 1.4 | 2.8 and above |
| YugabyteDB Python Driver for YCQL | Documentation | 3.25.0 |
| Project | Documentation and Guides | Example Apps |
|---|---|---|
| SQLAlchemy | Documentation Hello World |
SQLAlchemy ORM App |
| Django | Documentation Hello World |
Django ORM App |
Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations by referring to Connect an app or Use an ORM.
Prerequisites
To develop Python applications for YugabyteDB, you need the following:
-
Python
Ensure your system has Python3 installed. To check the version of Python installed, use the following command:
python -VIf not already installed, download and install it from the Python Downloads page.
-
YugabyteDB cluster
- Create a free cluster on YugabyteDB Aeon. Refer to Use a cloud cluster. Note that YugabyteDB Aeon requires SSL.
- Alternatively, set up a standalone YugabyteDB cluster by following the steps in Install YugabyteDB.