MySQL Shell Python client

MySQL Shell is an advanced client for MySQL Server that allow system administrator to perform both cluster and instance level operations, using a single binary.

This project provides a Python client to perform the most common set of operations, in addition to a set of predefined queries to cover most of the common use-cases.

🧑‍💻 Usage

Install MySQL Shell.
Install the package from PyPi:
```
pip install mysql-shell-client
```

Import and build the executors:

from mysql_shell.executors import LocalExecutor
from mysql_shell.models import ConnectionDetails

cluster_conn = ConnectionDetails(
    username="...",
    password="...",
    host="...",
    port="...",
)
instance_conn = ConnectionDetails(
    username="...",
    password="...",
    host="...",
    port="...",
)

cluster_executor = LocalExecutor(cluster_conn, "mysqlsh")
instance_executor = LocalExecutor(instance_conn, "mysqlsh")

Import and build the clients:

from mysql_shell.builders.quoting import ArgsQuoter, QueryQuoter
from mysql_shell.clients import ClusterClient, InstanceClient

args_quoter = ArgsQuoter()
query_quoter = QueryQuoter()

cluster_client = ClusterClient(cluster_executor, args_quoter)
instance_client = InstanceClient(instance_executor, query_quoter)

🔧 Development

Dependencies

In order to install all the required packages:

poetry install --all-extras

Linting

All Python files are linted using Ruff, to run it:

tox -e lint

Testing

Project testing is performed using Pytest, to run them:

tox -e unit

export MYSQL_DATABASE="test"
export MYSQL_USERNAME="root"
export MYSQL_PASSWORD="root_pass"
export MYSQL_SHELL_PATH="mysqlsh"

sudo --preserve-env docker compose -f compose/mysql-8.0.yaml up --wait && tox -e integration
sudo --preserve-env docker compose -f compose/mysql-8.0.yaml down

Release

Commits can be tagged to create releases of the package, in order to do so:

Bump up the version within the pyproject.toml file.
Add a new section to the CHANGELOG.md.
Commit + push the changes.
Trigger the release workflow.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mysql_shell_client-1.1.1.tar.gz (20.6 kB view details)

Uploaded Aug 17, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mysql_shell_client-1.1.1-py3-none-any.whl (30.3 kB view details)

Uploaded Aug 17, 2026 Python 3

File details

Details for the file mysql_shell_client-1.1.1.tar.gz.

File metadata

Download URL: mysql_shell_client-1.1.1.tar.gz
Upload date: Aug 17, 2026
Size: 20.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mysql_shell_client-1.1.1.tar.gz
Algorithm	Hash digest
SHA256	`b562df2c7cff2ebc3585c1098f8a729f0dfd6a4d09375f2648535f724544007c`
MD5	`adb4ba2406ca5cc497e1bc154770e40a`
BLAKE2b-256	`f52acdf20a8f6b5a2210d15a256f97c7c694ff65e7cecb34d5ebaaa6793fd6cc`

See more details on using hashes here.

Provenance

The following attestation bundles were made for mysql_shell_client-1.1.1.tar.gz:

Publisher: release.yaml on canonical/mysql-shell-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: mysql_shell_client-1.1.1.tar.gz
- Subject digest: b562df2c7cff2ebc3585c1098f8a729f0dfd6a4d09375f2648535f724544007c
- Sigstore transparency entry: 2498086043
- Sigstore integration time: Aug 17, 2026
Source repository:
- Permalink: canonical/mysql-shell-client@195a4646c2807baf5394700d7cb6cfba34fc14f6
- Branch / Tag: refs/heads/main
- Owner: https://github.com/canonical
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@195a4646c2807baf5394700d7cb6cfba34fc14f6
- Trigger Event: workflow_dispatch