mycli 2.3.0__tar.gz → 2.5.0__tar.gz

{mycli-2.3.0 → mycli-2.5.0}/.github/workflows/ci.yml

@@ -22,14 +22,14 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
         with:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -64,14 +64,14 @@ jobs:
         python-version: ["3.14"]
 
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
         with:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -114,14 +114,14 @@ jobs:
         python-version: ['3.14']
 
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
         with:
           version: 'latest'
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -217,14 +217,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
         with:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.14'
 

{mycli-2.3.0 → mycli-2.5.0}/.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
       - name: Run ruff check
         uses: astral-sh/ruff-action@278981a28ce3188b1e39527901f38254bf3aac89 # v4.1.0

{mycli-2.3.0 → mycli-2.5.0}/.github/workflows/publish.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
     - name: Require release changelog form
       run: |
@@ -28,13 +28,13 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
-    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
-    - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
       with:
         version: "latest"
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -72,14 +72,14 @@ jobs:
         python-version: ["3.14"]
 
     steps:
-    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
       with:
         version: "latest"
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -122,14 +122,14 @@ jobs:
         python-version: ['3.14']
 
     steps:
-    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
       with:
         version: 'latest'
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -225,13 +225,13 @@ jobs:
     needs: [tests, tests-macos, tests-windows, tests-wsl]
 
     steps:
-    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
-    - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
       with:
         version: "latest"
 
     - name: Set up Python
-      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: '3.14'
 
@@ -262,4 +262,4 @@ jobs:
         name: python-packages
         path: dist/
     - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+      uses: pypa/gh-action-pypi-publish@ba38be9e461d3875417946c167d0b5f3d385a247 # v1.14.1

{mycli-2.3.0 → mycli-2.5.0}/.github/workflows/typecheck.yml

@@ -18,14 +18,14 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
       - name: Set up Python
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.14'
 
-      - uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
         with:
           version: 'latest'
 

{mycli-2.3.0 → mycli-2.5.0}/AGENTS.md

@@ -48,6 +48,8 @@ A command line client for MySQL with auto-completion and syntax highlighting.
 ├── 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/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-2.3.0/mycli.egg-info → mycli-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.3.0
+Version: 2.5.0
 Summary: CLI for MySQL Database. With auto-completion and syntax highlighting.
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -36,8 +36,11 @@ Requires-Dist: llm~=0.30.0; extra == "llm"
 Requires-Dist: pydantic_core~=2.41.5; extra == "llm"
 Requires-Dist: setuptools==82.*; extra == "llm"
 Requires-Dist: pip==26.*; extra == "llm"
+Provides-Extra: dataframe
+Requires-Dist: polars~=1.42.1; extra == "dataframe"
+Requires-Dist: altair~=6.2.2; extra == "dataframe"
 Provides-Extra: all
-Requires-Dist: mycli[llm]; extra == "all"
+Requires-Dist: mycli[dataframe,llm]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: behave~=1.3.3; extra == "dev"
 Requires-Dist: coverage~=7.13.4; extra == "dev"
@@ -53,6 +56,8 @@ Requires-Dist: pydantic_core~=2.41.5; extra == "dev"
 Requires-Dist: setuptools==82.*; extra == "dev"
 Requires-Dist: pip==26.*; extra == "dev"
 Requires-Dist: ruff~=0.15.0; extra == "dev"
+Requires-Dist: polars~=1.42.1; extra == "dev"
+Requires-Dist: altair~=6.2.2; extra == "dev"
 Dynamic: license-file
 
 # mycli
@@ -128,6 +133,7 @@ Features
 * Pretty print tabular data (with colors!).
 * Support for SSL connections
 * Shell-style trailing redirects with `$>`, `$>>` and `$|` operators.
+* [Polars](https://pola.rs) dataframe [transforms](doc/transforms.md) with `.|` and Parquet saves with `.>`.
 * Support for querying LLMs with context derived from your schema using `/llm`.
 * Support for storing passwords in the system keyring.
 

{mycli-2.3.0 → mycli-2.5.0}/README.md

@@ -71,6 +71,7 @@ Features
 * Pretty print tabular data (with colors!).
 * Support for SSL connections
 * Shell-style trailing redirects with `$>`, `$>>` and `$|` operators.
+* [Polars](https://pola.rs) dataframe [transforms](doc/transforms.md) with `.|` and Parquet saves with `.>`.
 * Support for querying LLMs with context derived from your schema using `/llm`.
 * Support for storing passwords in the system keyring.
 

{mycli-2.3.0 → mycli-2.5.0}/changelog.md

@@ -1,3 +1,39 @@
+2.5.0 (2026/07/22)
+==============
+
+Features
+---------
+* Configurable sources of credentials to save to the keyring.
+* Trailing operator `.|` to transform query results as dataframes.
+* Trailing operator `.>` to save query results as parquet files.
+
+
+Internal
+---------
+* Don't modify checked-in `test/myclirc` in the behave test suite.
+
+
+2.4.0 (2026/07/18)
+==============
+
+Features
+---------
+* Make password sources and precedence configurable.
+* Ability to deselect fallback interactive password prompt.
+* Add `\e` prompt/toolbar format string for edit mode.
+
+
+Bug Fixes
+---------
+* Don't create `~/.myclirc` if the user adopted the XDG layout for myclirc.
+
+
+Internal
+---------
+* Make flaky `/watch` test even more lenient for CI.
+* Add missing file to `AGENTS.md` project layout.
+
+
 2.3.0 (2026/07/16)
 ==============
 

mycli-2.5.0/doc/transforms.md

@@ -0,0 +1,98 @@
+# Transforms with Polars Dataframes
+
+## Installing
+
+Install mycli with dataframe support using:
+
+```bash
+pip install --upgrade 'mycli[dataframe]'
+```
+
+or install the Polars and Altair libraries separately.
+
+## BETA STATUS
+
+Dataframe transforms are new and experimental.  The interface and functionality
+may still change.
+
+Here are some known limitations:
+
+ * transforms can't be mixed with `$|` shell redirection
+ * multiple transform steps are not permitted
+ * the Altair library is provided, but plots can't yet be displayed
+ * results from `UNION`s may be unable to be transformed
+
+And there are inherent limitations to the post-processing model: the entire
+SQL result must be transferred from the server and loaded into local memory.
+
+## Transforming
+
+In the interactive REPL, append the `.|` operator and a Python expression to a
+single SQL statement.  The Python expression receives
+
+ * `df`, a Polars `DataFrame`
+ * `pl`, the Polars module
+ * `alt`, the Altair module
+
+Spaces may be required around the operator.
+
+Transform example:
+
+```sql
+SELECT * FROM orders .| df.group_by('customer_id').len();
+```
+
+which is equivalent to this native SQL:
+
+```sql
+SELECT customer_id, COUNT(1) AS len FROM orders GROUP BY customer_id;
+```
+
+Transform expressions run with normal Python privileges, and expressions
+should not be run from untrusted sources.  If the transform operation
+returns a Polars `DataFrame` or `Series`, the result is rendered by mycli
+as tabular output; other return types currently give a warning and cannot
+be displayed.
+
+Transform expressions are useful for operations such as medians which
+cannot be done (or are simply awkward) in SQL.  Example:
+
+```sql
+SELECT * FROM orders .| df.describe();
+```
+
+## Saving
+
+A query result, transformed `DataFrame`, or transformed `Series` can be
+written directly to Parquet with the `.>` operator.
+
+Save example:
+
+```sql
+SELECT * FROM orders .> orders.parquet;
+```
+
+The `.>` operator must be last, requires a `.parquet` destination, and
+overwrites any existing file.  Spaces may be required around the operator.
+Destination paths containing whitespace must be quoted.  A successful write
+reports its destination and row count.
+
+When `post_redirect_command` is set in `~/.myclirc`, the given command runs
+after a successful Parquet save.
+
+`.>` cannot be combined with `\x`, `\G`, or `\g` special display terminators.
+
+## Combining
+
+Parquet saves may be combined with dataframe transforms.  Again, `.>` must
+be the last operator.
+
+Combined transform and save example:
+
+```sql
+SELECT * FROM orders .| df.group_by('customer_id').len() .> customer_counts.parquet;
+```
+
+```sql
+SELECT * FROM orders .| df['order_id'] .> order_ids.parquet;
+```

{mycli-2.3.0 → mycli-2.5.0}/mycli/TIPS

@@ -288,6 +288,8 @@ set editor_command = "code --wait" in ~/.myclirc to edit queries using VS Code!
 
 set up an interactive output explorer using the "[explorer]" section of ~/.myclirc!
 
+customize password sources/precedence with "password_sources" in ~/.myclirc!
+
 ###
 ### redirection
 ###

{mycli-2.3.0 → mycli-2.5.0}/mycli/cli_runner.py

@@ -15,6 +15,7 @@ from mycli.main_modes.checkup import main_checkup
 from mycli.main_modes.execute import main_execute_from_cli
 from mycli.main_modes.list_dsn import main_list_dsn
 from mycli.packages.cli_utils import is_valid_connection_scheme
+from mycli.password_sources import PasswordCandidates
 from mycli.vault import (
     DEFAULT_VAULT_EXECUTABLE,
     DEFAULT_VAULT_PASSWORD_FIELD,
@@ -165,10 +166,15 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
     database = cli_args.dbname or cli_args.database
 
     dsn_uri = None
+    dsn_password: str | None = None
 
     # Treat the database argument as a DSN alias only if it matches a configured alias
     # todo why is port tested but not socket?
-    truthy_password = cli_args.password not in (None, EMPTY_PASSWORD_FLAG_SENTINEL)
+    truthy_password = (
+        cli_args.password not in (None, EMPTY_PASSWORD_FLAG_SENTINEL)
+        or cli_args.password_file is not None
+        or os.environ.get('MYSQL_PWD') is not None
+    )
     if (
         database
         and "://" not in database
@@ -235,9 +241,6 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
             database = dsn_database
         if not cli_args.user and dsn_user is not None:
             cli_args.user = dsn_user
-        # todo: rationalize the behavior of empty-string passwords here
-        if not cli_args.password and dsn_password is not None:
-            cli_args.password = dsn_password
         if not cli_args.host:
             cli_args.host = dsn_host
         if not cli_args.port:
@@ -364,25 +367,40 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
         use_keyring = str_to_bool(cli_args.use_keyring)
         reset_keyring = False
 
-    if cli_args.password is None and cli_args.vault_secret:
+    password_candidates = PasswordCandidates()
+    if cli_args.password == EMPTY_PASSWORD_FLAG_SENTINEL:
+        password_candidates.add_value('prompt', cli_args.password)
+    elif cli_args.password is not None:
+        password_candidates.add_value('literal', cli_args.password)
+    if cli_args.password_file:
+        password_candidates.add_loader('file', lambda: main_module.get_password_from_file(cli_args.password_file))
+    if os.environ.get('MYSQL_PWD') is not None:
+        password_candidates.add_value('environment', os.environ.get('MYSQL_PWD'))
+    if dsn_password is not None:
+        password_candidates.add_value('dsn', dsn_password)
+
+    if cli_args.vault_secret:
+        vault_secret = cli_args.vault_secret
         vault_config = mycli.config.get('vault_beta', {})
         vault_address = cli_args.vault_address or os.environ.get('VAULT_ADDR') or vault_config.get('address') or None
         vault_mount = cli_args.vault_mount or vault_config.get('default_mount') or None
         vault_field = cli_args.vault_password_field or vault_config.get('default_password_field') or DEFAULT_VAULT_PASSWORD_FIELD
         vault_executable = vault_config.get('vault_executable') or DEFAULT_VAULT_EXECUTABLE
-        try:
-            vault_password: str | None = get_field_from_vault(
-                vault_field,
-                cli_args.vault_secret,
-                executable=vault_executable,
-                mount=vault_mount,
-                address=vault_address,
-            )
-        except VaultError as exc:
-            click.secho(f'Error reading password from Vault: {exc}', err=True, fg='red')
-            sys.exit(1)
-    else:
-        vault_password = None
+
+        def load_vault_password() -> str | None:
+            try:
+                return get_field_from_vault(
+                    vault_field,
+                    vault_secret,
+                    executable=vault_executable,
+                    mount=vault_mount,
+                    address=vault_address,
+                )
+            except VaultError as exc:
+                click.secho(f'Error reading password from Vault: {exc}', err=True, fg='red')
+                sys.exit(1)
+
+        password_candidates.add_loader('vault', load_vault_password)
 
     if cli_args.user is None and cli_args.vault_secret:
         vault_config = mycli.config.get('vault_beta', {})
@@ -409,7 +427,7 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
         mycli.connect(
             database=database,
             user=vault_username if cli_args.user is None else cli_args.user,
-            passwd=vault_password if cli_args.password is None else cli_args.password,
+            password_candidates=password_candidates,
             host=cli_args.host,
             port=cli_args.port,
             socket=cli_args.socket,

{mycli-2.3.0 → mycli-2.5.0}/mycli/client.py

@@ -58,9 +58,9 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
 
     # check XDG_CONFIG_HOME exists and not an empty string
     xdg_config_home = os.environ.get("XDG_CONFIG_HOME", "~/.config")
+    xdg_config_file = os.path.join(os.path.expanduser(xdg_config_home), "mycli", "myclirc")
     system_config_files: list[str | IO[str]] = [
         "/etc/myclirc",
-        os.path.join(os.path.expanduser(xdg_config_home), "mycli", "myclirc"),
     ]
 
     def __init__(
@@ -72,7 +72,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         login_path: str | None = None,
         auto_vertical_output: bool = False,
         warn: bool | None = None,
-        myclirc: str = "~/.myclirc",
+        myclirc: str | None = None,
         show_warnings: bool | None = None,
         cli_verbosity: int = 0,
     ) -> None:
@@ -87,6 +87,12 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.sandbox_mode: bool = False
         self.checkpoint: IO | None = None
 
+        if myclirc is None:
+            if os.path.exists(self.xdg_config_file):
+                myclirc = self.xdg_config_file
+            else:
+                myclirc = '~/.myclirc'
+
         # Load config.
         config_files: list[str | IO[str]] = self.system_config_files + [myclirc]