PyMySQL

This package contains a pure-Python MySQL and MariaDB client library, based on PEP 249.

Requirements

Python -- one of the following:
- CPython : 3.9 and newer
- PyPy : Latest 3.x version
MySQL Server -- one of the following:
- MySQL LTS versions
- MariaDB LTS versions

Installation

Package is uploaded on PyPI.

You can install it with pip:

$ python3 -m pip install PyMySQL

To use "sha256_password" or "caching_sha2_password" for authenticate, you need to install additional dependency:

$ python3 -m pip install PyMySQL[rsa]

To use MariaDB's "ed25519" authentication method, you need to install additional dependency:

$ python3 -m pip install PyMySQL[ed25519]

Documentation

Documentation is available online: https://pymysql.readthedocs.io/

For support, please refer to the StackOverflow.

Example

The following examples make use of a simple table

CREATE TABLE `users` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `email` varchar(255) COLLATE utf8_bin NOT NULL,
    `password` varchar(255) COLLATE utf8_bin NOT NULL,
    PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin
AUTO_INCREMENT=1 ;

import pymysql.cursors

# Connect to the database
connection = pymysql.connect(
    host="localhost",
    user="user",
    password="passwd",
    database="db",
    cursorclass=pymysql.cursors.DictCursor,
)

with connection:
    with connection.cursor() as cursor:
        # Create a new record
        sql = "INSERT INTO `users` (`email`, `password`) VALUES (%s, %s)"
        cursor.execute(sql, ("webmaster@python.org", "very-secret"))

    # connection is not autocommit by default. So you must commit to save
    # your changes.
    connection.commit()

    with connection.cursor() as cursor:
        # Read a single record
        sql = "SELECT `id`, `password` FROM `users` WHERE `email`=%s"
        cursor.execute(sql, ("webmaster@python.org",))
        result = cursor.fetchone()
        print(result)

This example will print:

{"password": "very-secret", "id": 1}

Resources

DB-API 2.0: https://www.python.org/dev/peps/pep-0249/
MySQL Reference Manuals: https://dev.mysql.com/doc/
Getting Help With MariaDB https://mariadb.com/kb/en/getting-help-with-mariadb/
MySQL client/server protocol: https://dev.mysql.com/doc/internals/en/client-server-protocol.html
"Connector" channel in MySQL Community Slack: https://lefred.be/mysql-community-on-slack/
PyMySQL mailing list: https://groups.google.com/forum/#!forum/pymysql-users

License

PyMySQL is released under the MIT License. See LICENSE for more information.

Release files for PyMySQL 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for PyMySQL 1.2.1
File	Size	Uploaded
pymysql-1.2.1.tar.gz	50.4 kB	Sep 17, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for PyMySQL 1.2.1
File	Interpreter	ABI	Platform	Reset
pymysql-1.2.1-py3-none-any.whl 46.6 kB Sep 17, 2026	Python 3	none	any	Details

Total release size:97.0 kB

Release files / pymysql-1.2.1.tar.gz

Download URL	pymysql-1.2.1.tar.gz
Size	50.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`707ac743d0e3bde3f1a8210ce5ecb1814fd40a0bbb04a17c9e8a9553836a4a4a`
BLAKE2b-256 checksum How to use checksums	`0078528a2e2d133fb925590a1e21c07ae308d9a1ca74c6c9250e0c9fa789d40c`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/PyMySQL/PyMySQL
Publishing commit: github.com/PyMySQL/PyMySQL/tree/26a031dbd56c0e3575bf251ff787b15fd7b1795a

Workflow

Publishing configuration: github.com/PyMySQL/PyMySQL/blob/26a031dbd56c0e3575bf251ff787b15fd7b1795a/.github/workflows/publish.yml
Publishing logs: github.com/PyMySQL/PyMySQL/actions/runs/35200132306/attempts/1

Artifact

Subject: pymysql-1.2.1.tar.gz
SHA-256 checksum: 707ac743d0e3bde3f1a8210ce5ecb1814fd40a0bbb04a17c9e8a9553836a4a4a Verifying attestations

Release files / pymysql-1.2.1-py3-none-any.whl

Download URL	pymysql-1.2.1-py3-none-any.whl
Size	46.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`cdf7e7f5cf4de6aa221bed3982d8090badcb5975daa9534328255f95bf4035c9`
BLAKE2b-256 checksum How to use checksums	`1ae2d6bc8488f21017fedd90b3339d1f1c1dbf141cac204e423d72bdbe224f25`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/PyMySQL/PyMySQL
Publishing commit: github.com/PyMySQL/PyMySQL/tree/26a031dbd56c0e3575bf251ff787b15fd7b1795a

Workflow

Publishing configuration: github.com/PyMySQL/PyMySQL/blob/26a031dbd56c0e3575bf251ff787b15fd7b1795a/.github/workflows/publish.yml
Publishing logs: github.com/PyMySQL/PyMySQL/actions/runs/35200132306/attempts/1

Artifact

Subject: pymysql-1.2.1-py3-none-any.whl
SHA-256 checksum: cdf7e7f5cf4de6aa221bed3982d8090badcb5975daa9534328255f95bf4035c9 Verifying attestations