{"id":36945217,"url":"https://github.com/canonical/mysql-shell-client","last_synced_at":"2026-06-08T09:00:33.245Z","repository":{"id":327022242,"uuid":"1107498601","full_name":"canonical/mysql-shell-client","owner":"canonical","description":"Package to interact with MySQL Shell","archived":false,"fork":false,"pushed_at":"2026-06-05T12:41:39.000Z","size":168,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-06-05T14:18:52.988Z","etag":null,"topics":["data-platform","library","mysql"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mysql-shell-client","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/canonical.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-01T08:15:44.000Z","updated_at":"2026-06-02T13:23:17.000Z","dependencies_parsed_at":"2026-01-12T11:01:53.054Z","dependency_job_id":null,"html_url":"https://github.com/canonical/mysql-shell-client","commit_stats":null,"previous_names":["canonical/mysql-shell-client"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/canonical/mysql-shell-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmysql-shell-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmysql-shell-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmysql-shell-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmysql-shell-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/canonical","download_url":"https://codeload.github.com/canonical/mysql-shell-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmysql-shell-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34055249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-platform","library","mysql"],"created_at":"2026-01-13T11:13:14.717Z","updated_at":"2026-06-08T09:00:33.237Z","avatar_url":"https://github.com/canonical.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MySQL Shell Python client\n\n[![CI/CD Status][ci-status-badge]][ci-status-link]\n[![Coverage Status][cov-status-badge]][cov-status-link]\n[![Apache license][apache-license-badge]][apache-license-link]\n\nMySQL Shell is an advanced client for MySQL Server that allow system administrator to perform both\ncluster and instance level operations, using a single binary.\n\nThis project provides a Python client to perform the most common set of operations,\nin addition to a set of predefined queries to cover most of the common use-cases.\n\n## 🧑‍💻 Usage\n\n1. [Install MySQL Shell][mysql-shell-downloads].\n\n2. Install the package from PyPi:\n   ```shell\n   pip install mysql-shell-client\n   ```\n\n3. Import and build the executors:\n   ```python\n   from mysql_shell.executors import LocalExecutor\n   from mysql_shell.models import ConnectionDetails\n\n   cluster_conn = ConnectionDetails(\n       username=\"...\",\n       password=\"...\",\n       host=\"...\",\n       port=\"...\",\n   )\n   instance_conn = ConnectionDetails(\n       username=\"...\",\n       password=\"...\",\n       host=\"...\",\n       port=\"...\",\n   )\n   \n   cluster_executor = LocalExecutor(cluster_conn, \"mysqlsh\")\n   instance_executor = LocalExecutor(instance_conn, \"mysqlsh\")\n   ```\n\n4. Import and build the clients:\n   ```python\n   from mysql_shell.builders.quoting import ArgsQuoter, QueryQuoter\n   from mysql_shell.clients import ClusterClient, InstanceClient\n\n   args_quoter = ArgsQuoter()\n   query_quoter = QueryQuoter()\n\n   cluster_client = ClusterClient(cluster_executor, args_quoter)\n   instance_client = InstanceClient(instance_executor, query_quoter)\n   ```\n\n## 🔧 Development\n\n### Dependencies\nIn order to install all the required packages:\n\n```shell\npoetry install --all-extras\n```\n\n### Linting\nAll Python files are linted using [Ruff][docs-ruff], to run it:\n\n```shell\ntox -e lint\n```\n\n### Testing\nProject testing is performed using [Pytest][docs-pytest], to run them:\n\n```shell\ntox -e unit\n```\n\n```shell\nexport MYSQL_DATABASE=\"test\"\nexport MYSQL_USERNAME=\"root\"\nexport MYSQL_PASSWORD=\"root_pass\"\nexport MYSQL_SHELL_PATH=\"mysqlsh\"\n\nsudo --preserve-env docker compose -f compose/mysql-8.0.yaml up --wait \u0026\u0026 tox -e integration\nsudo --preserve-env docker compose -f compose/mysql-8.0.yaml down\n```\n\n### Release\nCommits can be tagged to create releases of the package, in order to do so:\n\n1. Bump up the version within the `pyproject.toml` file.\n2. Add a new section to the `CHANGELOG.md`.\n3. Commit + push the changes.\n4. Trigger the [release workflow][github-workflows].\n\n[apache-license-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg\n[apache-license-link]: https://github.com/canonical/mysql-shell-client/blob/main/LICENSE\n[ci-status-badge]: https://github.com/canonical/mysql-shell-client/actions/workflows/ci.yaml/badge.svg?branch=main\n[ci-status-link]: https://github.com/canonical/mysql-shell-client/actions/workflows/ci.yaml?query=branch%3Amain\n[cov-status-badge]: https://codecov.io/gh/canonical/mysql-shell-client/branch/main/graph/badge.svg\n[cov-status-link]: https://codecov.io/gh/canonical/mysql-shell-client\n\n[docs-pytest]: https://docs.pytest.org/en/latest/#\n[docs-ruff]: https://docs.astral.sh/ruff/\n[github-workflows]: https://github.com/canonical/mysql-shell-client/actions/workflows/release.yaml\n\n[mysql-shell-downloads]: https://dev.mysql.com/downloads/shell/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanonical%2Fmysql-shell-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcanonical%2Fmysql-shell-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanonical%2Fmysql-shell-client/lists"}