mycli 2.25.1__tar.gz → 2.25.3__tar.gz

{mycli-2.25.1 → mycli-2.25.3}/.github/workflows/ci.yml

@@ -19,7 +19,7 @@ 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
@@ -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:
@@ -214,7 +214,7 @@ 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:
@@ -250,13 +250,34 @@ jobs:
         run: |
           uv run tox -e py3.14
 
-  docker-build:
-    name: Build Docker Image
+  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@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.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

{mycli-2.25.1 → mycli-2.25.3}/.github/workflows/publish.yml

@@ -28,7 +28,7 @@ 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
@@ -277,6 +277,8 @@ jobs:
     needs: [build]
     environment: release
 
+    # some of these permissions are probably not needed since attestations
+    # were removed
     permissions:
       contents: read
       packages: write
@@ -295,6 +297,7 @@ 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
@@ -305,6 +308,8 @@ jobs:
       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
@@ -314,6 +319,8 @@ jobs:
         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 }}

mycli-2.25.3/AGENTS.md

@@ -0,0 +1,143 @@
+# 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
+    ├── 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/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/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
+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 `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 `uv run -- tox`.
+
+#### Python Compatibility
+
+Use Python features available from Python 3.10 through Python 3.14.
+Compatibility with Python 3.9 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: `uv run -- ruff format`
+ * Linter: `uv run -- ruff check`
+ * Type checker: `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.25.3/AUTHORS.md

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

{mycli-2.25.1/mycli.egg-info → mycli-2.25.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.25.1
+Version: 2.25.3
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -27,7 +27,7 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-License-File: AUTHORS.rst
+License-File: AUTHORS.md
 Requires-Dist: click~=8.5.0
 Requires-Dist: clickdc~=0.1.1
 Requires-Dist: cryptography~=50.0.1
@@ -111,41 +111,52 @@ Release 2.0.0 has [breaking changes](https://github.com/dbcli/mycli/blob/v2.0.0/
 If you already know how to install Python packages, then you can install mycli
 via `pip`.  This package is always up to date.
 
-You might need `sudo` on Linux.
-
 ```bash
 pip install --upgrade 'mycli[all]'
 ```
 
-or, on macOS (`pygments` is optional but recommended):
+or, on macOS (`pygments` is optional):
 
 ```bash
 brew update && brew install mycli pygments
 ```
 
-or, on Debian or Ubuntu (`fzf` and `pygments` are optional but recommended):
+or, on Debian or Ubuntu (`fzf` and `pygments` are optional):
 
 ```bash
-sudo apt-get install mycli fzf python3-pygments
+apt-get install mycli fzf python3-pygments
 ```
 
-# Usage
+## Try Without Installing: uv
 
-See
+```bash
+uv tool run 'mycli[all]' --help
+```
+
+## Try Without Installing: Docker
+
+The images on Dockerhub are out of date!  [ghcr.io](https://github.com/dbcli/mycli/pkgs/container/mycli) images are preferred.  A sample database
+is included:
 
 ```bash
-mycli --help
+docker run --pull=always -it ghcr.io/dbcli/mycli:latest
+```
+
+The same image works with macOS [container](https://github.com/apple/container):
+
+```bash
+container run -it ghcr.io/dbcli/mycli:latest
 ```
 
 # Features
 
 * Auto-completion as you type for SQL keywords as well as tables, views, columns, enums, and more!
-* Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
-* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
-* Syntax highlighting using [Pygments](https://pygments.org/).
 * Smart-completion suggests context-sensitive completion:
     - `SELECT * FROM `<kbd>tab</kbd> will only show table names.
     - `SELECT * FROM users WHERE `<kbd>tab</kbd> will only show column names.
+* Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
+* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
+* Syntax highlighting using [Pygments](https://pygments.org/).
 * Multiline queries.
 * Favorite queries with positional or named parameters using [Jinja](https://jinja.palletsprojects.com/en/stable/). Save a query using
     ```
@@ -156,8 +167,7 @@ mycli --help
     /f alias --key=value
     ```
 * Timing of SQL statements and table rendering.
-* Logging of every query and its results to a file (off by default).
-* Pretty printing of tabular data.
+* Many output formats for tabular results.
 * Shell-style trailing redirects with `$>`, `$>>` and `$|` operators.
 * [Polars](https://pola.rs) dataframe [transforms and plots](https://github.com/dbcli/mycli/blob/main/doc/transforms.md) with `.|`, and Parquet saves with `.>`.
 * [Querying LLMs](https://www.mycli.net/llm) with context derived from your schema using `/llm`.
@@ -168,10 +178,19 @@ mycli --help
 Mycli creates a config file `~/.myclirc` on the first run; you can use the
 options in that file to configure the above features, and more.
 
-Some features are only exposed as [key bindings](https://github.com/dbcli/mycli/blob/main/doc/key_bindings.rst).
+Some features are only exposed as [key bindings](https://github.com/dbcli/mycli/blob/main/doc/key_bindings.md).
+
+
+# Usage
+
+See
+
+```bash
+mycli --help
+```
 
 
-# Contributions
+# Contributing
 
 If you're interested in contributing to this project, first of all we would like
 to extend our heartfelt gratitude. We've written a small doc to describe how to
@@ -179,6 +198,7 @@ get mycli running in a development setup.
 
 https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md
 
+
 # Additional Install Instructions
 
 ## Shell Completions
@@ -203,8 +223,9 @@ loaded with `source`.
 ## Alternative Install Methods
 
 These are some alternative ways to install mycli that are not managed by our
-team but provided by OS package maintainers.  OS packages could be considerably
-out of date.
+team but provided by OS package maintainers.
+
+**NOTE: OS packages could be considerably out of date.**
 
 If present, the `fzf` package can be used for fuzzy history search, and as an
 output "explorer" with the `\x` special command. `pygmentize` can be used for
@@ -227,7 +248,7 @@ using apt.  The `fzf` and `python3-pygments` packages are optional but
 recommended:
 
 ```bash
-sudo apt-get install mycli fzf python3-pygments
+apt-get install mycli fzf python3-pygments
 ```
 
 ### Fedora
@@ -236,15 +257,7 @@ Fedora has a package available for mycli; install it using dnf.  The `fzf` and
 `python-pygments` packages are optional but recommended:
 
 ```bash
-sudo dnf install mycli fzf python-pygments
-```
-
-### Docker
-
-The images on Dockerhub are out of date.  ghcr.io is preferred.  Example:
-
-```
-docker run --pull=always -it ghcr.io/dbcli/mycli:latest
+dnf install mycli fzf python-pygments
 ```
 
 ### Windows
@@ -272,7 +285,7 @@ With WSL, you are probably using an Ubuntu distribution, in which case
 recommended dependencies can be installed by
 
 ```bash
-sudo apt-get install fzf python3-pygments
+apt-get install fzf python3-pygments
 ```
 
 and mycli can be installed by `apt-get` or by `pip` (recommended):

{mycli-2.25.1 → mycli-2.25.3}/README.md

@@ -39,41 +39,52 @@ Release 2.0.0 has [breaking changes](https://github.com/dbcli/mycli/blob/v2.0.0/
 If you already know how to install Python packages, then you can install mycli
 via `pip`.  This package is always up to date.
 
-You might need `sudo` on Linux.
-
 ```bash
 pip install --upgrade 'mycli[all]'
 ```
 
-or, on macOS (`pygments` is optional but recommended):
+or, on macOS (`pygments` is optional):
 
 ```bash
 brew update && brew install mycli pygments
 ```
 
-or, on Debian or Ubuntu (`fzf` and `pygments` are optional but recommended):
+or, on Debian or Ubuntu (`fzf` and `pygments` are optional):
 
 ```bash
-sudo apt-get install mycli fzf python3-pygments
+apt-get install mycli fzf python3-pygments
 ```
 
-# Usage
+## Try Without Installing: uv
 
-See
+```bash
+uv tool run 'mycli[all]' --help
+```
+
+## Try Without Installing: Docker
+
+The images on Dockerhub are out of date!  [ghcr.io](https://github.com/dbcli/mycli/pkgs/container/mycli) images are preferred.  A sample database
+is included:
 
 ```bash
-mycli --help
+docker run --pull=always -it ghcr.io/dbcli/mycli:latest
+```
+
+The same image works with macOS [container](https://github.com/apple/container):
+
+```bash
+container run -it ghcr.io/dbcli/mycli:latest
 ```
 
 # Features
 
 * Auto-completion as you type for SQL keywords as well as tables, views, columns, enums, and more!
-* Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
-* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
-* Syntax highlighting using [Pygments](https://pygments.org/).
 * Smart-completion suggests context-sensitive completion:
     - `SELECT * FROM `<kbd>tab</kbd> will only show table names.
     - `SELECT * FROM users WHERE `<kbd>tab</kbd> will only show column names.
+* Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
+* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
+* Syntax highlighting using [Pygments](https://pygments.org/).
 * Multiline queries.
 * Favorite queries with positional or named parameters using [Jinja](https://jinja.palletsprojects.com/en/stable/). Save a query using
     ```
@@ -84,8 +95,7 @@ mycli --help
     /f alias --key=value
     ```
 * Timing of SQL statements and table rendering.
-* Logging of every query and its results to a file (off by default).
-* Pretty printing of tabular data.
+* Many output formats for tabular results.
 * Shell-style trailing redirects with `$>`, `$>>` and `$|` operators.
 * [Polars](https://pola.rs) dataframe [transforms and plots](https://github.com/dbcli/mycli/blob/main/doc/transforms.md) with `.|`, and Parquet saves with `.>`.
 * [Querying LLMs](https://www.mycli.net/llm) with context derived from your schema using `/llm`.
@@ -96,10 +106,19 @@ mycli --help
 Mycli creates a config file `~/.myclirc` on the first run; you can use the
 options in that file to configure the above features, and more.
 
-Some features are only exposed as [key bindings](https://github.com/dbcli/mycli/blob/main/doc/key_bindings.rst).
+Some features are only exposed as [key bindings](https://github.com/dbcli/mycli/blob/main/doc/key_bindings.md).
+
+
+# Usage
+
+See
+
+```bash
+mycli --help
+```
 
 
-# Contributions
+# Contributing
 
 If you're interested in contributing to this project, first of all we would like
 to extend our heartfelt gratitude. We've written a small doc to describe how to
@@ -107,6 +126,7 @@ get mycli running in a development setup.
 
 https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md
 
+
 # Additional Install Instructions
 
 ## Shell Completions
@@ -131,8 +151,9 @@ loaded with `source`.
 ## Alternative Install Methods
 
 These are some alternative ways to install mycli that are not managed by our
-team but provided by OS package maintainers.  OS packages could be considerably
-out of date.
+team but provided by OS package maintainers.
+
+**NOTE: OS packages could be considerably out of date.**
 
 If present, the `fzf` package can be used for fuzzy history search, and as an
 output "explorer" with the `\x` special command. `pygmentize` can be used for
@@ -155,7 +176,7 @@ using apt.  The `fzf` and `python3-pygments` packages are optional but
 recommended:
 
 ```bash
-sudo apt-get install mycli fzf python3-pygments
+apt-get install mycli fzf python3-pygments
 ```
 
 ### Fedora
@@ -164,15 +185,7 @@ Fedora has a package available for mycli; install it using dnf.  The `fzf` and
 `python-pygments` packages are optional but recommended:
 
 ```bash
-sudo dnf install mycli fzf python-pygments
-```
-
-### Docker
-
-The images on Dockerhub are out of date.  ghcr.io is preferred.  Example:
-
-```
-docker run --pull=always -it ghcr.io/dbcli/mycli:latest
+dnf install mycli fzf python-pygments
 ```
 
 ### Windows
@@ -200,7 +213,7 @@ With WSL, you are probably using an Ubuntu distribution, in which case
 recommended dependencies can be installed by
 
 ```bash
-sudo apt-get install fzf python3-pygments
+apt-get install fzf python3-pygments
 ```
 
 and mycli can be installed by `apt-get` or by `pip` (recommended):

mycli-2.25.3/SPONSORS.md

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

{mycli-2.25.1 → mycli-2.25.3}/changelog.md

@@ -1,3 +1,31 @@
+2.25.3 (2026/09/19)
+==============
+
+Documentation
+--------
+* Add "try without installing" instructions to `README.md`.
+* General `README.md` refinements.
+* Convert remaining RST files to Markdown.
+* Formatting in `AGENTS.md`.
+* Revise transforms document to use employee sample database.
+
+
+Internal
+--------
+* Naming and commentary in GitHub Actions.
+* Build ARM Docker image in CI.
+* Remove Python 3.10 from CI test matrix.
+* Restore provenance/sbom to Docker image action.
+
+
+2.25.2 (2026/09/16)
+==============
+
+Internal
+--------
+* Remove provenance/sbom from Docker image action.
+
+
 2.25.1 (2026/09/16)
 ==============