mycli 1.76.0__tar.gz → 2.0.0__tar.gz

{mycli-1.76.0 → mycli-2.0.0}/.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -71,7 +71,7 @@ jobs:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -121,7 +121,7 @@ jobs:
           version: 'latest'
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -130,7 +130,7 @@ jobs:
         run: uv sync --all-extras -p ${{ matrix.python-version }}
 
       - name: Set up MySQL
-        uses: shogo82148/actions-setup-mysql@b35e23af29aa7b32dc3c434e87a53e12d5706911 # v1.52.0
+        uses: shogo82148/actions-setup-mysql@076e636c45996ec8cb1a455c65f9f5364aeebd8a # v1.52.1
         with:
           mysql-version: '9.7'
           root-password: root
@@ -165,7 +165,7 @@ jobs:
         run: |
           mkdir -p /root/mycli
 
-      - uses: ubuntu/wsl/.github/actions/wsl-checkout@c23a4a0b03292618a19966ec299b799417d25580
+      - uses: ubuntu/wsl/.github/actions/wsl-checkout@f861f1083e518354e4c3637b08c0edfcf8bc3d51
         with:
           distro: Ubuntu-24.04
           working-dir: /root/mycli
@@ -224,7 +224,7 @@ jobs:
           version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: '3.14'
 

mycli-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,265 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: read
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+    - name: Require release changelog form
+      run: |
+        if grep -q TBD changelog.md; then false; fi
+
+  tests:
+    runs-on: ubuntu-latest
+    needs: [docs]
+    continue-on-error: true
+
+    strategy:
+      matrix:
+        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@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      with:
+        version: "latest"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Start MySQL
+      run: |
+        sudo /etc/init.d/mysql start
+
+    - name: Install dependencies
+      run: uv sync --all-extras -p ${{ matrix.python-version }}
+
+    - name: Wait for MySQL connection
+      run: |
+        while ! mysqladmin ping --host=localhost --port=3306 --user=root --password=root --silent; do
+          sleep 5
+        done
+
+    - 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
+
+  tests-macos:
+    name: Tests macOS
+    runs-on: macos-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.14"]
+
+    steps:
+    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+    - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      with:
+        version: "latest"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Set up MySQL
+      run: |
+        brew install mysql
+
+    - name: Start MySQL
+      run: |
+        brew services start mysql
+
+    - name: Install dependencies
+      run: uv sync --all-extras -p ${{ matrix.python-version }}
+
+    - name: Wait for MySQL connection
+      run: |
+        while ! mysqladmin ping --host=localhost --port=3306 --user=root --silent; do
+          sleep 5
+        done
+
+    - name: Set MySQL test credentials
+      run: |
+        $(brew --prefix mysql)/bin/mysqladmin --host=localhost --port=3306 --user=root password root
+
+    - name: Pytest / behave
+      env:
+        PYTEST_PASSWORD: root
+        PYTEST_HOST: 127.0.0.1
+        TERM: xterm
+      run: |
+        uv run tox -e py${{ matrix.python-version }}
+
+  tests-windows:
+    name: Tests Windows
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.14']
+
+    steps:
+    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+    - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      with:
+        version: 'latest'
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      shell: cmd
+      run: uv sync --all-extras -p ${{ matrix.python-version }}
+
+    - name: Set up MySQL
+      uses: shogo82148/actions-setup-mysql@076e636c45996ec8cb1a455c65f9f5364aeebd8a # v1.52.1
+      with:
+        mysql-version: '9.7'
+        root-password: root
+
+    - name: Run pytest
+      env:
+        PYTEST_PASSWORD: root
+        PYTEST_HOST: 127.0.0.1
+      run: |
+        uv run -- coverage run -m pytest
+        uv run -- coverage report -m --sort=Miss --skip-covered --skip-empty
+
+  tests-wsl:
+    name: Tests WSL
+    runs-on: windows-latest
+
+    steps:
+    - uses: vampire/setup-wsl@d1da7f2c0322a5ee4f24975344f67fc0f5baf364 # v7.0.0
+      with:
+        distribution: Ubuntu-24.04
+        update: 'true'
+        additional-packages: |
+          curl
+          git
+          mysql-server
+          pkg-config
+          build-essential
+          python3-pip
+
+    - name: Create working directory
+      shell: wsl-bash {0}
+      run: |
+        mkdir -p /root/mycli
+
+    - uses: ubuntu/wsl/.github/actions/wsl-checkout@f861f1083e518354e4c3637b08c0edfcf8bc3d51
+      with:
+        distro: Ubuntu-24.04
+        working-dir: /root/mycli
+
+    - name: Install uv
+      shell: wsl-bash {0}
+      run: |
+        export PATH="$HOME/.local/bin:$PATH"
+        env PYTHONPATH=/usr/local/lib/python3.14/site-packages pip install --upgrade --break-system-packages --prefix=/usr uv
+
+    - name: Install dependencies
+      shell: wsl-bash {0}
+      run: |
+        export PATH="$HOME/.local/bin:$PATH"
+        cd /root/mycli
+        uv sync --all-extras --python 3.14
+
+    - name: Start MySQL in WSL
+      shell: wsl-bash {0}
+      run: |
+        sudo service mysql start
+
+    - name: Wait for MySQL connection
+      shell: wsl-bash {0}
+      run: |
+        while ! mysqladmin ping --host=localhost --port=3306 --user=root --silent; do
+          sleep 5
+        done
+
+    - name: Set up MySQL
+      shell: wsl-bash {0}
+      run: |
+        mysqladmin -u root password root
+
+    - name: Run pytest
+      shell: wsl-bash {0}
+      env:
+        PYTEST_HOST: 127.0.0.1
+        PYTEST_USER: root
+        PYTEST_PASSWORD: root
+      run: |
+        export PATH="$HOME/.local/bin:$PATH"
+        cd /root/mycli
+        uv run --python 3.14 -- coverage run -m pytest
+        uv run --python 3.14 -- coverage report -m --sort=Miss --skip-covered --skip-empty
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [tests, tests-macos, tests-windows, tests-wsl]
+
+    steps:
+    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+    - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      with:
+        version: "latest"
+
+    - name: Set up Python
+      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      with:
+        python-version: '3.14'
+
+    - name: Install dependencies
+      run: uv sync --all-extras -p 3.14
+
+    - name: Build
+      run: uv build
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+      with:
+        name: python-packages
+        path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [build]
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+    - name: Download distribution packages
+      uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+      with:
+        name: python-packages
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0

{mycli-1.76.0 → mycli-2.0.0}/.github/workflows/typecheck.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
 
       - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
         with:
           python-version: '3.14'
 

{mycli-1.76.0 → mycli-2.0.0}/AGENTS.md

@@ -39,7 +39,6 @@ A command line client for MySQL with auto-completion and syntax highlighting.
 ├── 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/paramiko_stub/         # stub in case the Paramiko library is not installed
 ├── mycli/packages/sql_utils.py           # utilities for parsing SQL statements
 ├── mycli/packages/ptoolkit/              # extends prompt_toolkit
 ├── mycli/packages/special/               # implementation of mycli special commands

{mycli-1.76.0/mycli.egg-info → mycli-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 1.76.0
+Version: 2.0.0
 Summary: CLI for MySQL Database. With auto-completion and syntax highlighting.
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -31,16 +31,12 @@ Requires-Dist: pyfzf~=0.3.1
 Requires-Dist: rapidfuzz~=3.14.3
 Requires-Dist: keyring~=25.7.0
 Requires-Dist: yaspin~=3.4.0
-Provides-Extra: ssh
-Requires-Dist: paramiko~=3.5.1; extra == "ssh"
-Requires-Dist: sshtunnel~=0.4.0; extra == "ssh"
 Provides-Extra: llm
 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: all
-Requires-Dist: mycli[ssh]; extra == "all"
 Requires-Dist: mycli[llm]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: behave~=1.3.3; extra == "dev"
@@ -52,8 +48,6 @@ Requires-Dist: pytest-cov~=7.0.0; extra == "dev"
 Requires-Dist: pytest-random-order~=1.2.0; extra == "dev"
 Requires-Dist: tox~=4.35.0; extra == "dev"
 Requires-Dist: pdbpp~=0.11.7; extra == "dev"
-Requires-Dist: paramiko~=3.5.1; extra == "dev"
-Requires-Dist: sshtunnel~=0.4.0; extra == "dev"
 Requires-Dist: llm~=0.30.0; extra == "dev"
 Requires-Dist: pydantic_core~=2.41.5; extra == "dev"
 Requires-Dist: setuptools==82.*; extra == "dev"
@@ -65,7 +59,7 @@ Dynamic: license-file
 
 [![Build Status](https://github.com/dbcli/mycli/workflows/mycli/badge.svg)](https://github.com/dbcli/mycli/actions?query=workflow%3Amycli)
 
-A command line client for MySQL that can do auto-completion and syntax highlighting.
+A command line client for MySQL with auto-completion and syntax highlighting.
 
 Homepage: [https://mycli.net](https://mycli.net)
 Documentation: [https://mycli.net/docs](https://mycli.net/docs)
@@ -73,31 +67,38 @@ Documentation: [https://mycli.net/docs](https://mycli.net/docs)
 ![Completion](doc/screenshots/tables.png)
 ![CompletionGif](doc/screenshots/main.gif)
 
-Mycli is compatible with MySQL, MariaDB, Percona, TiDB, and Doris.
+Mycli is compatible with MySQL, MariaDB, Percona, TiDB, and Apache Doris.
 
 Postgres Equivalent: [https://pgcli.com](https://pgcli.com)
 
+Release 2.x
+-----------
+
+Release 2.0.0 has [breaking changes](https://github.com/dbcli/mycli/blob/v2.0.0/changelog.md#breaking-changes)!
+
+
 Quick Start
 -----------
 
-If you already know how to install Python packages, then you can install it via `pip`:
+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.
+You might need `sudo` on Linux.
 
 ```bash
-pip install -U 'mycli[all]'
+pip install --upgrade 'mycli[all]'
 ```
 
-or
+or, only on macOS (`fzf` and `pygments` are optional):
 
 ```bash
-brew update && brew install mycli  # Only on macOS
+brew update && brew install mycli fzf pygments
 ```
 
-or
+or, only on Debian or Ubuntu (`fzf` and `pygments` are optional):
 
 ```bash
-sudo apt-get install mycli  # Only on Debian or Ubuntu
+sudo apt-get install mycli fzf python3-pygments
 ```
 
 ### Usage
@@ -111,67 +112,82 @@ mycli --help
 Features
 --------
 
-`mycli` is written using [prompt_toolkit](https://github.com/jonathanslenders/python-prompt-toolkit/).
-
-* Auto-completion as you type for SQL keywords as well as tables, views and
-  columns in the database.
+* 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).
-* Syntax highlighting using Pygments.
+* Syntax highlighting using [Pygments](https://pygments.org/).
 * Smart-completion (enabled by default) will suggest context-sensitive completion.
     - `SELECT * FROM <tab>` will only show table names.
     - `SELECT * FROM users WHERE <tab>` will only show column names.
 * Support for multiline queries.
 * Favorite queries with optional positional parameters. Save a query using
-  `\fs <alias> <query>` and execute it with `\f <alias>`.
+  `/fs <alias> <query>` and execute it with `/f <alias>`.
 * Timing of sql statements and table rendering.
 * Log every query and its results to a file (disabled by default).
 * Pretty print tabular data (with colors!).
 * Support for SSL connections
 * Shell-style trailing redirects with `$>`, `$>>` and `$|` operators.
-* Support for querying LLMs with context derived from your schema.
+* Support for querying LLMs with context derived from your schema using `/llm`.
 * Support for storing passwords in the system keyring.
 
-Mycli creates a config file `~/.myclirc` on first run; you can use the
+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](doc/key_bindings.rst).
 
-Contributions:
+
+Implementation
 --------------
 
-If you're interested in contributing to this project, first of all I would like
-to extend my heartfelt gratitude. I've written a small doc to describe how to
-get this running in a development setup.
+`mycli` is written using [prompt_toolkit](https://github.com/jonathanslenders/python-prompt-toolkit/) and other Python libraries.
+
+
+Contributions
+-------------
+
+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
+get mycli running in a development setup.
 
 https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md
 
 
 ## Additional Install Instructions:
 
-These are some alternative ways to install mycli that are not managed by our team but provided by OS package maintainers. These packages could be slightly out of date and take time to release the latest version.
+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 somewhat
+out of date.
+
+If present, the `fzf` package can be used for fuzzy history search, and
+`pygemtize` can be used for syntax highlighting within the fuzzy history
+search.  The `less` package is also expected, but almost always already
+installed.
 
 ### Arch, Manjaro
 
-You can install the mycli package available in the AUR:
+You can install the `mycli` package available in the AUR.  `fzf` and
+`python-pygments` are optional:
 
-```
-yay -S mycli
+```bash
+yay -S mycli fzf python-pygments
 ```
 
 ### Debian, Ubuntu
 
-On Debian, Ubuntu distributions, you can easily install the mycli package using apt:
+On Debian and Ubuntu distributions, you can easily install the mycli package
+using apt.  The `fzf` and `python3-pygments` packages are optional:
 
-```
-sudo apt-get install mycli
+```bash
+sudo apt-get install mycli fzf python3-pygments
 ```
 
 ### Fedora
 
-Fedora has a package available for mycli, install it using dnf:
+Fedora has a package available for mycli; install it using dnf.  The `fzf` and
+`python-pygments` packages are optional:
 
-```
-sudo dnf install mycli
+```bash
+sudo dnf install mycli fzf python-pygments
 ```
 
 ### Windows
@@ -182,20 +198,22 @@ Install the `less` pager, for example by `scoop install less`.
 
 Follow the instructions on this blogpost: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
 
-**Mycli is not tested on Windows**, but the libraries used in the app are Windows-compatible.
-This means it should work without any modifications, but isn't supported.
+The libraries used in mycli are Windows-compatible, but there are known
+limitations according to the test suite.  The basics work without any
+modifications, but this configuration isn't supported software at this time.
 
-PRs to add native Windows testing to Mycli CI would be welcome!
+PRs to address shortcomings on Windows would be welcome!
 
 #### Option 2: WSL
 
-Everything should work as expected in WSL.  This is a good option for using
-Mycli on Windows.
+Mycli is more compatible with WSL than with native Windows, though still
+not 100% perfect.  This is a good option for using mycli on Windows.
 
+PRs to complete WSL support would be welcome!
 
-### Thanks:
+### Thanks
 
-This project was funded through kickstarter. My thanks to the [backers](https://mycli.net/sponsors) who supported the project.
+This project was funded through kickstarter. Our thanks to the [backers](https://mycli.net/sponsors) who supported the project.
 
 A special thanks to [Jonathan Slenders](https://twitter.com/jonathan_s) for
 creating [Python Prompt Toolkit](https://github.com/jonathanslenders/python-prompt-toolkit),
@@ -206,16 +224,19 @@ of this app.
 [Click](https://palletsprojects.com/projects/click) is used for command line option parsing
 and printing error messages.
 
-Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure python adapter to MySQL database.
+Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure Python adapter to MySQL databases.
 
 
 ### Compatibility
 
-Mycli is tested on macOS and Linux, and requires Python 3.10 or better.
+Mycli is tested on macOS (full), Linux (full), Windows (partial), and WSL
+(partial), and requires Python 3.10 or better.
 
-To connect to MySQL versions earlier than 5.5, you may need to set the following in `~/.myclirc`:
+To connect to MySQL versions earlier than 5.5, you may need to set the
+following in `~/.myclirc`:
 
-```
+```ini
+[connection]
 # character set for connections without --charset being set at the CLI
 default_character_set = utf8
 ```