qonsole 2.0.0__tar.gz

qonsole-2.0.0/.flake8

@@ -0,0 +1,4 @@
+# Flake8 config is not supported in pyproject.toml (yet)
+
+[flake8]
+max-line-length = 82

qonsole-2.0.0/.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

qonsole-2.0.0/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+#
+# Test the source for formatting and code check (pass/fail).
+#
+
+name: Linting
+
+on: [push, pull_request]
+
+jobs:
+
+  linting:
+    runs-on: ubuntu-latest
+    name: Ruff code check
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - run: pip install ruff
+      - run: |
+          ruff format --check
+          ruff check

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

@@ -0,0 +1,28 @@
+name: Upload to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  pypi-publish:
+    name: Publish release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qonsole
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6.0.2
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.4
+        with:
+          pixi-version: v0.63.2
+          cache: true
+          manifest-path: pyproject.toml
+      - name: Build package
+        run: |
+          pixi run --manifest-path ./pyproject.toml hatch build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

qonsole-2.0.0/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+#
+# This workflow will install the package and run the unittests.
+#
+
+name: PyTest tests
+
+on: [push, pull_request]
+
+jobs:
+
+  tests:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+        # On MacOS the tests are the fastest because no Qt dependencies need to be installed
+        os: [macos-latest]
+        qt: ["PySide6"]
+        include:
+          # Also try Ubuntu and Windows, but just with the most common options:
+          - { os: ubuntu-latest, python: "3.13", qt: "PySide6" }
+          - { os: windows-latest, python: "3.13", qt: "PySide6" }
+          # Also try other Qt packages, but just with the easiest OS and common Python version:
+          - { os: macos-latest, python: "3.13", qt: "PyQt6" }
+          - { os: macos-latest, python: "3.13", qt: "PyQt5" }
+
+    runs-on: ${{matrix.os}}
+
+    env:
+      # Allow Qt to run without rendering anything:
+      QT_QPA_PLATFORM: "offscreen"
+      XDG_RUNTIME_DIR: "/tmp/runtime-root"
+      # Force Qt test with a particular version:
+      PYTEST_QT_API: ${{ matrix.qt }}
+
+    steps:
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
+      with:
+        python-version: ${{matrix.python}}
+
+    - run: pip install coverage pytest pytest-qt ${{ matrix.qt }}
+    - run: pip install -e .
+
+    - name: Install Qt system dependencies
+      if: matrix.os == 'ubuntu-latest'
+      run: sudo apt-get update && sudo apt-get install -y libegl1 libxkbcommon-x11-0
+      # We need quite some packages for `pytest-qt` to run without problems
+
+    - run: coverage run -m pytest tests/ -v && coverage report

qonsole-2.0.0/.gitignore

@@ -0,0 +1,224 @@
+# From: https://github.com/github/gitignore/blob/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.DS_Store# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+.DS_Store

qonsole-2.0.0/LICENSE

@@ -0,0 +1,46 @@
+MIT License
+
+Copyright (c) 2026 Jacob Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------------------------------------------------------------------
+Pyqtconsole license:
+
+MIT License
+
+Copyright (c) 2015 Marcus Oscarsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qonsole-2.0.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: qonsole
+Version: 2.0.0
+Summary: Light-weight python interpreter, easy to embed into Qt applications
+Project-URL: Homepage, https://github.com/jacobwilliams/qonsole
+Author-email: Jacob Williams <jacobwilliams@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: autocompletion,console,interactive,interpreter,jedi,qt,shell
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Interpreters
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: <4.0,>=3.9
+Requires-Dist: ipython-pygments-lexers
+Requires-Dist: jedi
+Requires-Dist: pygments
+Requires-Dist: qtpy
+Provides-Extra: dev
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-qt; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+   <img src="https://raw.githubusercontent.com/jacobwilliams/qonsole/master/media/qonsole.png" width=400">
+</h1>
+
+<!-- Badges -->
+<p align="left">
+  <!-- Python version badge -->
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/language-python-blue.svg" alt="Python"></a>
+  <!-- PyPI badge -->
+  <a href="https://pypi.org/project/qonsole/"><img src="https://img.shields.io/pypi/v/qonsole.svg" alt="PyPI"></a>
+  <!-- conda-forge badge -->
+  <a href="https://anaconda.org/conda-forge/qonsole"><img src="https://img.shields.io/conda/vn/conda-forge/qonsole.svg" alt="Conda-Forge"></a>
+  <!-- GitHub Actions CI badge -->
+  <a href="https://github.com/jacobwilliams/qonsole/actions"><img src="https://github.com/jacobwilliams/qonsole/actions/workflows/docs.yml/badge.svg" alt="GitHub CI Status"></a>
+  <a href="https://github.com/jacobwilliams/qonsole/actions"><img src="https://github.com/jacobwilliams/qonsole/actions/workflows/publish.yml/badge.svg" alt="GitHub CI Status"></a>
+</p>
+
+# qonsole
+
+Qonsole is a lightweight Python console for Qt applications. It's made to
+be easy to embed in other PySide/PyQt applications and comes with some examples that
+show how this can be done. The interpreter can run in a separate thread, in
+the UI main thread or in a gevent task. Qonsole is a fork of [pyqtconsole](https://github.com/pyqtconsole/pyqtconsole). The two diverged at pyqtconsole v1.3.0, and it is not quite a drop-in replacement, but does implement new features and has various improvements.
+
+## Simple usage
+
+The following snippet shows how to create a console that will execute user
+input in a separate thread. Be aware that long running tasks will still block
+the main thread due to the GIL. See the ``examples`` directory for more
+examples.
+
+```python
+import sys
+from threading import Thread
+from PyQt5.QtWidgets import QApplication
+
+from qonsole import PythonConsole
+
+app = QApplication([])
+console = PythonConsole()
+console.show()
+console.eval_in_thread()
+
+sys.exit(app.exec_())
+```
+
+## Embedding
+
+* *Separate thread* - Runs the interpreter in a separate thread, see the
+  example `threaded.py`. Running the interpreter in a separate thread obviously
+  limits the interaction with the Qt application. The parts of Qt that needs
+  to be called from the main thread will not work properly, but is excellent
+  way for having a 'plain' python console in your Qt app.
+
+* *main thread* - Runs the interpreter in the main thread, see the example
+  `inuithread.py`. Makes full interaction with Qt possible, lenghty operations
+  will of course freeze the UI (as any lenghty operation that is called from
+  the main thread). This is a great alternative for people who does not want
+  to use the gevent based approach but still wants full interactivity with Qt.
+
+* *gevent* - Runs the interpreter in a gevent task, see the example
+  `_gevent.py`. Allows for full interactivity with Qt without special
+  consideration (at least to some extent) for longer running processes. The
+  best method if you want to use pyQtgraph, Matplotlib, PyMca or similar.
+
+## Features
+
+### Syntax highlighting
+
+Syntax highlighting is provided by the [https://pygments.org](pygments) library.
+Simply pass the Pygments style string to the ``PythonConsole`` constructer like so:
+
+```python
+console = PythonConsole(pygments_style='github-dark')
+```
+
+### Magic commands
+
+Commands that start with `%` are magic commands.
+This features provides IPython-like [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html) such as:
+
+ * `%pwd` -- Print current working directory
+ * `%cd` -- Change directory
+ * `%ls` -- List directory contents
+ * `%who` -- List variable names in the current namespace
+ * `%whos` -- Display detailed variable information
+ * `%timeit` -- Time the execution of a Python statement
+ * `%run` -- Execute a Python script file
+ * `%clear` -- Clear the console display
+ * `%help` -- Display help message for magic commands
+
+ In addition, custom magic commands can be defined by using the `add_magic_command()` method. Example:
+
+```python
+def version(args=None):
+    return '2.0.0'
+
+console = PythonConsole()
+console.add_magic_command("version", version)
+```
+
+Which can be used like so:
+
+```
+   IN [0]: %version
+           2.0.0
+```
+
+### Clear console
+
+A local method, named `clear()`, is available to clear the input screen and reset the line numbering.
+Enable it by pushing the method into the available namespace in the console:
+
+```python
+   console.interpreter.locals["clear"] = console.clear
+```
+
+### Shell commands
+
+Commands entered in the console that start with `!` will be executed as shell commands.
+The output of the command will be printed in the console.
+For example, on a Linux or macOS system, entering `!ls -l` will list the files in the current directory. Example:
+
+```
+   IN [0]: !ls -l
+   OUT[0]: total 16546
+           -rw-r--r-- 1 user user      18741 Fen  6  2026  file1.txt
+           -rw-r--r-- 1 user user      18741 Feb  6  2026  file2.txt
+```
+
+### Prompt String
+
+By default ``IN [n]:`` and ``OUT [n]:`` are displayed before each input and output line.
+You can customize this through constructor arguments:
+
+```python
+# Including the line numbers:
+console = PythonConsole(inprompt="%d >", outprompt="%d <")
+# Or just static:
+console = PythonConsole(inprompt=">>>", outprompt="<<<")
+```
+
+## Credits
+
+This module depends on [QtPy](https://github.com/spyder-ide/qtpy) which provides a compatibility layer for
+Qt. The console is tested under both Qt5 and Qt6.
+
+## Development
+
+To generate coverage information for the unit tests, run `coverage run -m pytest tests/ && coverage report -m && coverage html`