mycli 2.25.3__tar.gz → 2.26.0__tar.gz

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

@@ -264,7 +264,7 @@ jobs:
 
       - name: Build Docker image
         id: build
-        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
+        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
         with:
           context: .
           file: docker/Dockerfile
@@ -284,7 +284,7 @@ jobs:
 
       - name: Build Docker image
         id: build
-        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
+        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
         with:
           context: .
           file: docker/Dockerfile

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

@@ -314,7 +314,7 @@ jobs:
 
     - 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

{mycli-2.25.3 → mycli-2.26.0}/AGENTS.md

@@ -80,13 +80,13 @@ This repo uses `uv` for dependency management. **Always** prefix Python
 commands with `uv run`.  Example:
 
 ```bash
-uv run -- python script.py
+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 `uv run -- mypy --install-types --non-interactive script.py`.
+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`.
@@ -96,12 +96,13 @@ 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`.
+To run the full test suite, execute `env -u PYTHONPATH 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.
+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
 
@@ -113,9 +114,9 @@ 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`
+ * 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
 

mycli-2.26.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".

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.25.3
+Version: 2.26.0
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -15,7 +15,6 @@ Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -24,7 +23,7 @@ Classifier: Programming Language :: SQL
 Classifier: Topic :: Database
 Classifier: Topic :: Database :: Front-Ends
 Classifier: Topic :: Software Development
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 License-File: AUTHORS.md
@@ -33,7 +32,7 @@ Requires-Dist: clickdc~=0.1.1
 Requires-Dist: cryptography~=50.0.1
 Requires-Dist: Pygments~=2.21.0
 Requires-Dist: prompt_toolkit<4.0.0,>=3.0.41
-Requires-Dist: PyMySQL~=1.1.2
+Requires-Dist: PyMySQL~=1.2.3
 Requires-Dist: sqlparse~=0.6.0
 Requires-Dist: sqlglot~=30.17.0
 Requires-Dist: sqlglotc~=30.17.0
@@ -72,8 +71,9 @@ Dynamic: license-file
 
 # mycli
 
-[![Build Status](https://github.com/dbcli/mycli/workflows/mycli/badge.svg)](https://github.com/dbcli/mycli/actions?query=workflow%3Amycli)
-[![License](https://img.shields.io/github/license/dbcli/mycli.svg?color=2FC745)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/dbcli/mycli/ci.yml?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/actions/workflows/ci.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/mycli?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/mycli/)
+[![License](https://img.shields.io/github/license/dbcli/mycli.svg?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
 
 Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.
 
@@ -315,7 +315,7 @@ Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure Python adapte
 # Compatibility
 
 Mycli is tested on macOS (full), Linux (full), Windows (partial), and WSL
-(partial), and requires Python 3.10 or better.
+(partial), and requires Python 3.11 or better.
 
 To connect to MySQL versions earlier than 5.5, you may need to set the
 following in `~/.myclirc`:
@@ -336,3 +336,11 @@ Common topics include:
 - [Configuring mycli](https://mycli.net/config)
 - [Using/Disabling the pager](https://mycli.net/pager)
 - [Syntax colors](https://mycli.net/syntax)
+
+
+# License
+
+Mycli is Open Source Software provided under the [BSD 3-Clause License](LICENSE.txt).
+
+The Mycli Docker image and git repository include a copy of the [employees sample database](https://dev.mysql.com/doc/employee/en/)
+provided by Oracle under the [Creative Commons Attribution-Share Alike 3.0 Unported License](https://dev.mysql.com/doc/employee/en/employees-license.html).

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

@@ -1,7 +1,8 @@
 # mycli
 
-[![Build Status](https://github.com/dbcli/mycli/workflows/mycli/badge.svg)](https://github.com/dbcli/mycli/actions?query=workflow%3Amycli)
-[![License](https://img.shields.io/github/license/dbcli/mycli.svg?color=2FC745)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/dbcli/mycli/ci.yml?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/actions/workflows/ci.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/mycli?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/mycli/)
+[![License](https://img.shields.io/github/license/dbcli/mycli.svg?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
 
 Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.
 
@@ -243,7 +244,7 @@ Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure Python adapte
 # Compatibility
 
 Mycli is tested on macOS (full), Linux (full), Windows (partial), and WSL
-(partial), and requires Python 3.10 or better.
+(partial), and requires Python 3.11 or better.
 
 To connect to MySQL versions earlier than 5.5, you may need to set the
 following in `~/.myclirc`:
@@ -264,3 +265,11 @@ Common topics include:
 - [Configuring mycli](https://mycli.net/config)
 - [Using/Disabling the pager](https://mycli.net/pager)
 - [Syntax colors](https://mycli.net/syntax)
+
+
+# License
+
+Mycli is Open Source Software provided under the [BSD 3-Clause License](LICENSE.txt).
+
+The Mycli Docker image and git repository include a copy of the [employees sample database](https://dev.mysql.com/doc/employee/en/)
+provided by Oracle under the [Creative Commons Attribution-Share Alike 3.0 Unported License](https://dev.mysql.com/doc/employee/en/employees-license.html).