mycli 2.24.4__tar.gz → 2.28.0__tar.gz

{mycli-2.24.4 → mycli-2.28.0}/.github/dependabot.yml

@@ -1,6 +1,8 @@
 version: 2
 updates:
   - package-ecosystem: "github-actions"
+    cooldown:
+      default-days: 7
     directory: "/"
     schedule:
       interval: "daily"

{mycli-2.24.4 → mycli-2.28.0}/.github/workflows/ci.yml

@@ -19,12 +19,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
           version: "latest"
 
@@ -38,7 +38,7 @@ jobs:
           sudo /etc/init.d/mysql start
 
       - name: Install dependencies
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Wait for MySQL connection
         run: |
@@ -52,7 +52,7 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py${{ matrix.python-version }}
+          ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-macos:
     name: Tests macOS
@@ -66,7 +66,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
           version: "latest"
 
@@ -84,7 +84,7 @@ jobs:
           brew services start mysql
 
       - name: Install dependencies
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Wait for MySQL connection
         run: |
@@ -102,7 +102,7 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py${{ matrix.python-version }}
+          ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-windows:
     name: Tests Windows
@@ -116,7 +116,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
           version: 'latest'
 
@@ -127,10 +127,10 @@ jobs:
 
       - name: Install dependencies
         shell: cmd
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Set up MySQL
-        uses: shogo82148/actions-setup-mysql@62da9377d83991fce27b6ed2a397d3306121e41d # v1.53.1
+        uses: shogo82148/actions-setup-mysql@083ec148d28e62f2b24b8f4541693dfe1d50488d # v1.54.0
         with:
           mysql-version: '9.7'
           root-password: root
@@ -144,7 +144,7 @@ jobs:
           uv run -- coverage report -m --sort=Miss --skip-covered --skip-empty
 
   tests-wsl:
-    name: Tests WSL
+    name: Tests WSL (3.14)
     runs-on: windows-latest
 
     steps:
@@ -182,7 +182,7 @@ jobs:
         run: |
           export PATH="$HOME/.local/bin:$PATH"
           cd /root/mycli
-          uv sync --all-extras --python 3.14
+          uv sync --extra dev,llm,dataframe --python 3.14
 
       - name: Start MySQL in WSL
         shell: wsl-bash {0}
@@ -214,13 +214,13 @@ jobs:
           uv run --python 3.14 -- coverage report -m --sort=Miss --skip-covered --skip-empty
 
   test-no-extras:
-    name: Tests Without Extras
+    name: Tests Without Extras (3.14)
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
           version: "latest"
 
@@ -248,4 +248,44 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py3.14
+          ./.venv/bin/tox -e py3.14
+
+  docker-x86-build:
+    name: Build x86 Docker Image
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    # simpler than the steps in publish.yml, because we don't do the slow buildx multiarch
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Build Docker image
+        id: build
+        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: false
+
+  docker-arm-build:
+    name: Build ARM Docker Image
+    runs-on: ubuntu-24.04-arm
+
+    permissions:
+      contents: read
+
+    # simpler than the steps in publish.yml, because we don't do the slow buildx multiarch
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Build Docker image
+        id: build
+        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: false

{mycli-2.24.4 → mycli-2.28.0}/.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish Python Package
+name: Publish Packages
 
 on:
   release:
@@ -28,11 +28,11 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+    - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
       with:
         version: "latest"
 
@@ -46,7 +46,7 @@ jobs:
         sudo /etc/init.d/mysql start
 
     - name: Install dependencies
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Wait for MySQL connection
       run: |
@@ -54,16 +54,22 @@ jobs:
           sleep 5
         done
 
+      # arguably this should be made identical to CI for PRs
+      # better would be a composite GH action
+    - name: Run Style Checks
+      run: ./.venv/bin/tox -e style
+
+      # arguably this should be made identical to CI for PRs
+      # better would be a composite GH action
+    - name: Run Typechecker
+      run: ./.venv/bin/tox -e typecheck
+
     - name: Pytest / behave
       env:
         PYTEST_PASSWORD: root
         PYTEST_HOST: 127.0.0.1
       run: |
-        uv run tox -e py${{ matrix.python-version }}
-
-      # arguably this should be made identical to CI for PRs
-    - name: Run Style Checks
-      run: uv run tox -e style
+        ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-macos:
     name: Tests macOS
@@ -77,7 +83,7 @@ jobs:
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+    - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
       with:
         version: "latest"
 
@@ -95,7 +101,7 @@ jobs:
         brew services start mysql
 
     - name: Install dependencies
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Wait for MySQL connection
       run: |
@@ -113,7 +119,7 @@ jobs:
         PYTEST_HOST: 127.0.0.1
         TERM: xterm
       run: |
-        uv run tox -e py${{ matrix.python-version }}
+        ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-windows:
     name: Tests Windows
@@ -127,7 +133,7 @@ jobs:
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+    - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
       with:
         version: 'latest'
 
@@ -138,10 +144,10 @@ jobs:
 
     - name: Install dependencies
       shell: cmd
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Set up MySQL
-      uses: shogo82148/actions-setup-mysql@62da9377d83991fce27b6ed2a397d3306121e41d # v1.53.1
+      uses: shogo82148/actions-setup-mysql@083ec148d28e62f2b24b8f4541693dfe1d50488d # v1.54.0
       with:
         mysql-version: '9.7'
         root-password: root
@@ -193,7 +199,7 @@ jobs:
       run: |
         export PATH="$HOME/.local/bin:$PATH"
         cd /root/mycli
-        uv sync --all-extras --python 3.14
+        uv sync --extra dev,llm,dataframe --python 3.14
 
     - name: Start MySQL in WSL
       shell: wsl-bash {0}
@@ -230,7 +236,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+    - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
       with:
         version: "latest"
 
@@ -240,7 +246,7 @@ jobs:
         python-version: '3.14'
 
     - name: Install dependencies
-      run: uv sync --all-extras -p 3.14
+      run: uv sync --extra llm,dataframe -p 3.14
 
     - name: Build
       run: uv build
@@ -252,7 +258,7 @@ jobs:
         path: dist/
 
   publish-pypi:
-    name: Publish to PyPI
+    name: Publish Wheel to PyPI
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
     needs: [build]
@@ -269,12 +275,16 @@ jobs:
       uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
 
   publish-image:
-    name: Publish to ghcr.io
+    name: Publish Image to ghcr.io
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
+    # doesn't actually need the results of build, but it makes sense to run this
+    # concurrently with publish-pypi
     needs: [build]
     environment: release
 
+    # some of these permissions are probably not needed since attestations
+    # were removed
     permissions:
       contents: read
       packages: write
@@ -293,18 +303,31 @@ jobs:
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
 
+    # should be needed for multi-arch images
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
+
     - name: Extract metadata (tags, labels) for Docker
       id: meta
       uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
       with:
         images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      env:
+        # despite this setting, annotations only seem to appear at the index level
+        # on "docker buildx imagetools inspect"
+        DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index
 
     - name: Build and push Docker image
       id: push
-      uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
+      uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
       with:
         context: .
         file: docker/Dockerfile
         push: true
+        # the linux/arm64 arch will be very slow to build, so it is only made for
+        # publication, not testing
+        platforms: linux/amd64,linux/arm64
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}
+        annotations: ${{ steps.meta.outputs.annotations }}

{mycli-2.24.4 → mycli-2.28.0}/.github/workflows/typecheck.yml

@@ -25,12 +25,12 @@ jobs:
         with:
           python-version: '3.14'
 
-      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
           version: 'latest'
 
       - name: Install dependencies
-        run: uv sync --all-extras
+        run: uv sync --extra dev,llm,dataframe
 
       - name: Run mypy
         run: |

mycli-2.28.0/AGENTS.md

@@ -0,0 +1,152 @@
+# Mycli
+
+A command line client for MySQL with auto-completion and syntax highlighting.
+
+## Project Structure
+
+    /                                         # repository root
+    ├── .github/                              # GitHub Actions and configuration
+    ├── pyproject.toml                        # project configuration
+    ├── doc/                                  # documentation
+    ├── doc/cookbook.md                       # recipes for how to configure and use mycli
+    ├── doc/key_bindings.md                   # documentation of key binding behaviors
+    ├── doc/known_bugs.md                     # documentation of known bugs and limitations
+    ├── doc/llm.md                            # documentation on how to use LLM features
+    ├── doc/transforms.md                     # documentation on how to use dataframe transform/plot features
+    ├── doc/screenshots/                      # screenshots for documentation
+    ├── mycli/                                # application source
+    ├── mycli/__init__.py                     # provides version number
+    ├── mycli/app_state.py                    # `AppStateMixin` application state mixin and related functions
+    ├── mycli/boundary_tunnel.py              # connection over Boundary tunnel
+    ├── mycli/cli_runner.py                   # connects and dispatches main modes based on CLI arguments
+    ├── mycli/clibuffer.py                    # prompt_toolkit buffer utilities
+    ├── mycli/client_commands.py              # special commands which must be registered separately
+    ├── mycli/client_connection.py            # `ClientConnectionMixin` mixin for establishing the database connection
+    ├── mycli/client_query.py                 # `ClientQueryMixin` mixin for running queries and refreshing completions
+    ├── mycli/client.py                       # the `MyCli` "god class"
+    ├── mycli/clistyle.py                     # prompt_toolkit style utilities
+    ├── mycli/clitoolbar.py                   # prompt_toolkit toolbar utilities
+    ├── mycli/compat.py                       # OS compatibility helpers
+    ├── mycli/completion_refresher.py         # populates a `SQLCompleter` object in a background thread
+    ├── mycli/config.py                       # configuration file readers and utilities
+    ├── mycli/constants.py                    # shared constants
+    ├── mycli/key_bindings.py                 # prompt_toolkit key binding utilities
+    ├── mycli/keyring_utils.py                # saved credential utilities
+    ├── mycli/kubectl_tunnel.py               # connection over kubectl tunnel
+    ├── mycli/lexer.py                        # extends `MySqlLexer` from Pygments
+    ├── mycli/macos_keychain.py               # macOS Keychain credentials preserving access controls
+    ├── mycli/main.py                         # processes CLI arguments
+    ├── mycli/main_modes/                     # main execution paths
+    ├── mycli/main_modes/batch.py             # `--batch` mode
+    ├── mycli/main_modes/checkup.py           # `--checkup` mode
+    ├── mycli/main_modes/completions.py       # `--completions` mode
+    ├── mycli/main_modes/execute.py           # `--execute` mode
+    ├── mycli/main_modes/list_dsn.py          # `--list-dsn` mode
+    ├── mycli/main_modes/repl.py              # interactive REPL mode
+    ├── mycli/myclirc                         # project-level configuration file
+    ├── mycli/output.py                       # `OutputMixin` mixin for feedback and output of query results
+    ├── mycli/packages/                       # application packages
+    ├── mycli/packages/batch_utils.py         # utilities for `--batch` mode
+    ├── mycli/packages/cli_utils.py           # utilities for parsing CLI arguments
+    ├── mycli/packages/completion_engine.py   # implementation of completion suggestions
+    ├── mycli/packages/filepaths.py           # utilities for files, including completion suggestions
+    ├── mycli/packages/fzf.py                 # general interface to fzf chooser
+    ├── mycli/packages/hybrid_redirection.py  # implementation of shell-style redirects
+    ├── mycli/packages/interactive_utils.py   # utilities for confirming on destructive statements
+    ├── mycli/packages/key_binding_utils.py   # handlers for key bindings and related special commands
+    ├── mycli/packages/polars_completion.py   # completions for `.|` transforms
+    ├── mycli/packages/polars_transform.py    # implements `.|` transforms
+    ├── mycli/packages/ptoolkit/              # extends prompt_toolkit
+    ├── mycli/packages/special/               # implementation of mycli special commands
+    ├── mycli/packages/sql_utils.py           # utilities for parsing SQL statements
+    ├── mycli/packages/sqlresult.py           # the `SQLResult` dataclass for holding responses
+    ├── mycli/packages/string_utils.py        # generic string utilities
+    ├── mycli/packages/tabular_output/        # extends cli_helper with additional output formats
+    ├── mycli/password_sources.py             # password sources and precedence
+    ├── mycli/query_runner.py                 # run queries with query state and timing updates
+    ├── mycli/resources/completions/          # shell completions for CLI interface
+    ├── mycli/ssh_tunnel.py                   # connecting over a tunnel with `--ssh-jump`
+    ├── mycli/schema_prefetcher.py            # background prefetcher for multi-schema auto-completion
+    ├── mycli/sqlcompleter.py                 # offers SQL completions
+    ├── mycli/sqlexecute.py                   # runs SQL queries
+    ├── mycli/types.py                        # shared types
+    ├── mycli/vault.py                        # Vault integration
+    ├── test/features/                        # behave tests
+    ├── test/myclirc                          # mycli configuration used for tests
+    ├── test/mylogin.cnf                      # `mylogin.cnf` example used for tests
+    ├── test/pytests/                         # pytest tests
+    ├── test/pytests/conftest.py              # pytest configuration
+    └── test/utils.py                         # shared utilities for tests
+
+## Development
+
+### Python
+
+#### Python Dependency Management
+
+This repo uses `uv` for dependency management. **Always** prefix Python
+commands with `uv run`.  Example:
+
+```bash
+env -u PYTHONPATH uv run -- python script.py
+```
+
+#### Python Typing
+
+This repo uses type annotations which are checked by `mypy`.  **Always** add
+type annotations, and always check new code with `env -u PYTHONPATH uv run -- mypy --install-types --non-interactive script.py`.
+
+Use lower-case type annotations such as `tuple`, not upper-case type
+annotations such as `Tuple`.
+
+Use `Type | None` instead of `Optional[Type]`.
+
+#### Python Testing
+
+Tests are coordinated by `tox`, and include both `pytest` and `behave` tests.
+To run the full test suite, execute `env -u PYTHONPATH uv run -- tox`.
+
+#### Python Compatibility
+
+Use Python features available from Python 3.11 through Python 3.14.
+Compatibility with Python 3.9 is not needed.  Compatibility with Python
+3.10 is not needed.
+
+#### Python Style
+
+Import style: prefer `from package import name` over `import package.name as name`.
+
+Quoting style: prefer single quotes for new code, but do not remove double quotes
+from existing code.
+
+#### Python Environment
+
+ * Package manager: `uv` (not pip)
+ * Formatter: `env -u PYTHONPATH uv run -- ruff format`
+ * Linter: `env -u PYTHONPATH uv run -- ruff check`
+ * Type checker: `env -u PYTHONPATH uv run -- mypy --install-types --non-interactive`
+
+### Git Workflows
+
+#### Git Commit Messages
+
+ * Use the present tense.
+ * Keep the first line under 50 characters in length.
+ * Keep the second line blank.
+ * Keep all other lines under 72 characters in length.
+ * Reference issue numbers when available.
+
+#### Generating PRs
+
+When generating a PR, follow the instructions in `.github/PULL_REQUEST_TEMPLATE.md`:
+
+ * Add new author names to `mycli/AUTHORS`.
+ * Add a new entry to `changelog.md`.
+
+### Code Comments
+
+Keep comments concise and direct.  Use full sentences, ending with a period.
+
+### See Also
+
+See also the file `CONTRIBUTING.md`.

mycli-2.28.0/AUTHORS.md

@@ -0,0 +1 @@
+See [AUTHORS](mycli/AUTHORS)

mycli-2.28.0/CONTRIBUTING.md

@@ -0,0 +1,152 @@
+# Development Guide
+
+This is a guide for developers who would like to contribute to the project.
+
+If you're interested in contributing to mycli, thank you. We'd love your help!
+You'll always get credit and appreciation for your work.
+
+## GitHub Workflow
+
+1. [Fork the repository](https://github.com/dbcli/mycli) on GitHub.
+
+2. Clone your fork locally:
+
+    ```bash
+    git clone <url-for-your-fork>
+    ```
+
+3. Add the official repository (`upstream`) as a remote repository:
+
+    ```bash
+    git remote add upstream git@github.com:dbcli/mycli.git
+    ```
+
+4. Once you have added upstream, the following command will pull the latest changes to your local `main`:
+
+    ```bash
+    git pull upstream main
+    ```
+
+5. Set up [uv](https://docs.astral.sh/uv/getting-started/installation/)
+   for development:
+
+    ```bash
+    cd mycli
+    uv sync --all-extras
+    ```
+
+    We've just created a virtual environment and installed all the dependencies
+    and tools we need to work on mycli.
+
+6. Create a branch for your bugfix or feature based off the `main` branch:
+
+    ```bash
+    git checkout -b <name-of-bugfix-or-feature> main
+    ```
+
+7. When your work is ready for the mycli team to review it, push your branch to your fork:
+
+    ```bash
+    git push origin <name-of-bugfix-or-feature>
+    ```
+
+8. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
+   on GitHub.
+
+
+## Running Mycli with Changes
+
+To run mycli with your local changes:
+
+```bash
+uv run mycli
+```
+
+
+## Running the Tests
+
+While you work on mycli, it's important to run the tests to make sure your code
+hasn't broken any existing functionality. To run the tests, just run:
+
+```bash
+uv run tox
+```
+
+### Test Database Credentials
+
+Some tests require a database connection to work. You can tell the tests which
+credentials to use by setting the applicable environment variables:
+
+```bash
+export PYTEST_HOST=localhost
+export PYTEST_USER=mycli
+export PYTEST_PASSWORD=myclirocks
+export PYTEST_PORT=3306
+export PYTEST_CHARSET=utf8mb4
+```
+
+Since the default values are
+
+```bash
+export PYTEST_HOST=localhost
+export PYTEST_USER=root
+export PYTEST_PASSWORD=<no password>
+export PYTEST_PORT=3306
+export PYTEST_CHARSET=utf8mb4
+```
+
+for most cases you only need to set the values which differ from the defaults:
+
+```bash
+export PYTEST_USER=mycli
+export PYTEST_PASSWORD=myclirocks
+```
+
+If you would like to run the tests as a user with only the necessary privileges,
+create a `mycli` user on your MySQL server and run the following GRANT statements:
+
+```sql
+GRANT ALL PRIVILEGES ON `mycli_%`.* TO 'mycli'@'localhost';
+GRANT SELECT ON mysql.* TO 'mycli'@'localhost';
+GRANT SELECT ON performance_schema.* TO 'mycli'@'localhost';
+```
+
+### Editor Tests
+
+Some tests expect the program `ex` to be a symbolic link to `vim`.
+
+In some systems (e.g. Arch Linux) `ex` is a symbolic link to `vi`, which will
+change the output and therefore make some tests fail.
+
+You can check this by running:
+```bash
+readlink -f $(which ex)
+```
+
+# GitHub PR checklist
+
+ * add the contribution to `changelog.md`
+ * add your name to the `AUTHORS` file (or make sure it is already there)
+ * run
+
+    ```bash
+    uv run ruff check && uv run ruff format && uv run mypy --install-types .
+    ```
+
+
+## Releasing a New Version of Mycli (For Maintainers)
+
+We create a new [release](https://github.com/dbcli/mycli/releases) in GitHub. This triggers a GitHub Action which will
+
+ * run all the tests
+ * build a wheel and upload it to PyPI
+ * build a Docker image and upload it to ghcr.io
+
+Steps to create a release:
+
+ * Update `changelog.md`, setting the release version and date at the top.  Bump the feature version if there are new features in the changelog, otherwise only bump the patch version.  Merge this change.
+ * Navigate to https://github.com/dbcli/mycli/releases/new .
+ * Press "Select Tag" and enter the new version number.  It should be the same as in `changelog.md` but with a leading `v`.  It should not already exist.
+ * Press "Generate Release Notes", which will fill in the notes and the title.
+ * Sanity check the generated release notes.
+ * Press "Publish Release".