text-console 2.0.7__tar.gz → 2.1.0__tar.gz

text_console-2.1.0/LICENSE

@@ -0,0 +1,284 @@
+Copyright (c) 2024-2025 Ircama, EUPL-1.2
+
+Corresponding SPDX licence: European Union Public License 1.2
+
+Licence ID: EUPL-1.2
+
+See also:
+https://opensource.org/licenses/EUPL-1.2
+https://joinup.ec.europa.eu/software/page/eupl/licence-eupl
+
+European Union Public Licence
+V. 1.2
+
+EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as
+defined below) which is provided under the terms of this Licence. Any use of
+the Work, other than as authorised under this Licence is prohibited (to the
+extent such use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work: “Licensed under the EUPL”, or has expressed by
+any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+— ‘The Licence’: this Licence.
+— ‘The Original Work’: the work or software distributed or communicated by the
+  ‘Licensor under this Licence, available as Source Code and also as
+  ‘Executable Code as the case may be.
+— ‘Derivative Works’: the works or software that could be created by the
+  ‘Licensee, based upon the Original Work or modifications thereof. This
+  ‘Licence does not define the extent of modification or dependence on the
+  ‘Original Work required in order to classify a work as a Derivative Work;
+  ‘this extent is determined by copyright law applicable in the country
+  ‘mentioned in Article 15.
+— ‘The Work’: the Original Work or its Derivative Works.
+— ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+— ‘The Executable Code’: any code which has generally been compiled and which
+  is meant to be interpreted by a computer as a program.
+— ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+— ‘Contributor(s)’: any natural or legal person who modifies the Work under
+  the Licence, or otherwise contributes to the creation of a Derivative Work.
+— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright
+vested in the Original Work:
+
+— use the Work in any circumstance and for all usage,
+— reproduce the Work,
+— modify the Work, and make Derivative Works based upon the Work,
+— communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case
+  may be, the Work,
+— distribute the Work or copies thereof,
+— lend and rent the Work or copies thereof,
+— sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make
+effective the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights
+to any patents held by the Licensor, to the extent necessary to make use of
+the rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates,
+in a notice following the copyright notice attached to the Work, a repository
+where the Source Code is easily and freely accessible for as long as the
+Licensor continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits
+from any exception or limitation to the exclusive rights of the rights owners
+in the Work, of the exhaustion of those rights or of other applicable
+limitations thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and
+a copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of
+the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions
+on the Work or Derivative Work that alter or restrict the terms of the
+Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed
+under a Compatible Licence, this Distribution or Communication can be done
+under the terms of this Compatible Licence. For the sake of this clause,
+‘Compatible Licence’ refers to the licences listed in the appendix attached to
+this Licence. Should the Licensee's obligations under the Compatible Licence
+conflict with his/her obligations under this Licence, the obligations of the
+Compatible Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the
+Work, the Licensee will provide a machine-readable copy of the Source Code or
+indicate a repository where this Source will be easily and freely available
+for as long as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade
+names, trademarks, service marks, or names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she
+brings to the Work are owned by him/her or licensed to him/her and that he/she
+has the power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’
+basis and without warranties of any kind concerning the Work, including
+without limitation merchantability, fitness for a particular purpose, absence
+of defects or errors, accuracy, non-infringement of intellectual property
+rights other than copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a
+condition for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the
+use of the Work, including without limitation, damages for loss of goodwill,
+work stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such
+damage. However, the Licensor will be liable under statutory product liability
+laws as far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional
+agreement, defining obligations or services consistent with this Licence.
+However, if accepting obligations, You may act only on your own behalf and on
+your sole responsibility, not on behalf of the original Licensor or any other
+Contributor, and only if You agree to indemnify, defend, and hold each
+Contributor harmless for any liability incurred by, or claims asserted against
+such Contributor by the fact You have accepted any warranty or additional
+liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I
+agree’ placed under the bottom of a window displaying the text of this Licence
+or by affirming consent in any other similar way, in accordance with the rules
+of applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this
+Licence, such as the use of the Work, the creation by You of a Derivative Work
+or the Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of
+electronic communication by You (for example, by offering to download the Work
+from a remote location) the distribution channel or media (for example, a
+website) must at least provide to the public the information requested by the
+applicable law regarding the Licensor, the Licence and the way it may be
+accessible, concluded, stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence. Such a termination
+will not terminate the licences of any person who has received the Work from
+the Licensee under the Licence, provided such persons remain in full
+compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions
+of this Licence or updated versions of the Appendix, so far this is required
+and reasonable, without reducing the scope of the rights granted by the
+Licence. New versions of the Licence will be published with a unique version
+number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+— any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty
+  on the Functioning of the European Union,
+— any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive
+  jurisdiction of the competent court where the Licensor resides or conducts
+  its primary business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+— this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+— this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+— GNU General Public License (GPL) v. 2, v. 3
+— GNU Affero General Public License (AGPL) v. 3
+— Open Software License (OSL) v. 2.1, v. 3.0
+— Eclipse Public License (EPL) v. 1.0
+— CeCILL v. 2.0, v. 2.1
+— Mozilla Public Licence (MPL) v. 2
+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+— European Union Public Licence (EUPL) v. 1.1, v. 1.2
+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or
+  Strong Reciprocity (LiLiQ-R+)
+
+— The European Commission may update this Appendix to later versions of the
+  above licences without producing a new version of the EUPL, as long as they
+  provide the rights granted in Article 2 of this Licence and protect the
+  covered Source Code from exclusive appropriation.
+— All other changes or additions to this Appendix require the production of a
+  new EUPL version.

{text_console-2.0.7 → text_console-2.1.0}/PKG-INFO

@@ -1,31 +1,28 @@
 Metadata-Version: 2.4
 Name: text_console
-Version: 2.0.7
-Summary: ('A customizable Tkinter-based text console widget, in which a user types in commands to be sent to the Python interpreter.',)
-Home-page: https://github.com/Ircama/text_console
+Version: 2.1.0
+Summary: A customizable Tkinter-based text console widget, in which a user types in commands to be sent to the Python interpreter.
 Author: Ircama
-License: EUPL-1.2
-Keywords: shell console tkinter
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Programming Language :: Python :: 3 :: Only
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/Ircama/text_console
+Project-URL: Documentation, https://ircama.github.io/text_console
+Keywords: shell,console,tkinter
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
-Requires-Python: >3.6
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-python
-Dynamic: summary
 
 # text_console
 
@@ -119,5 +116,163 @@ In the History Panel:
 |Double-click|Recall command to main window from history panel|
 | Esc               | In history panel: Close Command History panel / Cancel search|
 
+## Installation
+
+Requires Python 3.9 or later (including Python 3.14).
+
+```bash
+pip install text-console
+```
+
+## Playground
+
+```
+python -m text_console
+```
+
+Available options:
+
+```
+Python Console [-h] [-V]
+
+options:
+  -h, --help     show this help message and exit
+  -V, --version  Print version and exit
+
+A customizable Tkinter-based text console widget.
+```
+
+### Running the pre-built GUI executable
+
+The *text_console.zip* archive in the [Releases](https://github.com/Ircama/text_console/releases/latest) folder incudes the *text_console.exe* executable asset; the ZIP archive is auto-generated by a [GitHub Action](https://github.com/Ircama/text_console/blob/main/.github/workflows/build.yml). *text_console.exe* is a Windows GUI that can be directly executed.
+
+### Basic usage with default settings
+
+```python
+import tkinter as tk
+from text_console import TextConsole
+
+class TkConsole(tk.Tk):
+    def __init__(self):
+        super().__init__()
+        self.title("Python Console")
+        self.geometry("800x400")
+
+        # Initialize the TextConsole widget
+        console = TextConsole(self, self)
+        console.pack(fill='both', expand=True)
+
+        # Configure grid resizing for the main window
+        self.grid_rowconfigure(0, weight=1)
+        self.grid_columnconfigure(0, weight=1)
+
+
+app = TkConsole()
+app.mainloop()
+```
+
+### Invoking TextConsole from a Master widget
+
+```python
+import tkinter as tk
+from text_console import TextConsole
+
+class TkConsole(tk.Tk):
+    def __init__(self):
+        super().__init__()
+        self.title("Python Console")
+        self.geometry("100x70")
+
+        # Add a button to launch the TextConsole
+        run_console_button = tk.Button(
+            self, 
+            text="Debug Console", 
+            command=self.run_text_console
+        )
+        run_console_button.pack(pady=20)  # Add some spacing around the button
+
+        # Configure grid resizing for the main window
+        self.grid_rowconfigure(0, weight=1)
+        self.grid_columnconfigure(0, weight=1)
+
+    def run_text_console(self):
+        """Launches the TextConsole in a new Toplevel window."""
+        console_window = tk.Toplevel(self)
+        console_window.title("Debug Console")
+        console_window.geometry("800x400")
+
+        # Initialize the TextConsole widget
+        console = TextConsole(self, console_window)
+        console.pack(fill='both', expand=True)
+
+app = TkConsole()
+app.mainloop()
+```
+
+### Customized console through subclassing
+
+```python
+from text_console import TextConsole
+
+class MyCustomConsole(TextConsole):
+
+    # Override class attributes
+    history_file = "my_custom_history.txt"
+
+    console_locals = {
+        "my_var": 42,
+        "my_function": lambda x: x * 2
+    }
+
+    context_menu_items = [
+        ("Custom Action", "custom_action"),
+        "-",  # separator
+        ("Clear", "clear")
+    ]
+
+    show_about_message = "My Custom Console v1.0"
+    show_help_content = "This is my custom console help content"
+    
+    def custom_action(self):
+        print("Custom action executed!")
+    
+    def create_menu(self, main, master):
+        # Extend the menu created by the base class
+        super().create_menu(main, master)
+        
+        # Add "Web Site" to the Help menu
+        menu_bar = master.nametowidget(master.cget('menu'))  # Get the menu widget
+        help_menu = list(menu_bar.children.values())[2]  # Access the Help menu (third = 2)
+        help_menu.insert_command(
+            help_menu.index("end"),
+            label="Web Site",
+            command=self.new_action
+        )
+
+    def new_action(self):
+        pass
+
+    """ Alternatively, override create_menu:
+    def create_menu(self, main, master):
+        # Override to create a custom menu
+        menu_bar = Menu(master)
+        master.config(menu=menu_bar)
+        
+        # Custom menu items
+        custom_menu = Menu(menu_bar, tearoff=0)
+        custom_menu.add_command(label="My Action", command=self.custom_action)
+        menu_bar.add_cascade(label="Custom", menu=custom_menu)
+    """
+
+
+# Use the custom console
+text_console = MyCustomConsole(main, master)
+```
+
+## Limitations
+
+*text\_console* does **not** support **Ctrl+C** to abort long‑running commands. Because the console is designed as an embeddable in-process API playground within a Tkinter process, it cannot leverage **multiprocessing** to provide real interrupt semantics, which would fork a separate Python environment, breaking the API. Likewise, **multithreading** cannot forcibly terminate an executing function due to Python’s **Global Interpreter Lock (GIL)** and the absence of a built-in thread‑kill API. Furthermore, Tkinter itself offers no mechanism to cancel an in‑progress widget callback or command/code evaluation and it runs inside an event loop rather than the standard Python REPL. Consequently, users must wait for blocking operations to finish.
+
+## License
 
-Full information and usage details at the [text_console GitHub repository](https://github.com/Ircama/text_console).
+EUPL-1.2 License - See [LICENSE](LICENSE) for details.

{text_console-2.0.7 → text_console-2.1.0}/README.md

@@ -92,6 +92,8 @@ In the History Panel:
 
 ## Installation
 
+Requires Python 3.9 or later (including Python 3.14).
+
 ```bash
 pip install text-console
 ```
@@ -107,7 +109,7 @@ Available options:
 ```
 Python Console [-h] [-V]
 
-optional arguments:
+options:
   -h, --help     show this help message and exit
   -V, --version  Print version and exit
 
@@ -208,8 +210,8 @@ class MyCustomConsole(TextConsole):
     def custom_action(self):
         print("Custom action executed!")
     
-    def create_menu(self, master):
-        # Override to create a custom menu
+    def create_menu(self, main, master):
+        # Extend the menu created by the base class
         super().create_menu(main, master)
         
         # Add "Web Site" to the Help menu
@@ -221,20 +223,11 @@ class MyCustomConsole(TextConsole):
             command=self.new_action
         )
 
-        # Override to create a custom menu
-        menu_bar = Menu(master)
-        master.config(menu=menu_bar)
-        
-        # Custom menu items
-        custom_menu = Menu(menu_bar, tearoff=0)
-        custom_menu.add_command(label="My Action", command=self.custom_action)
-        menu_bar.add_cascade(label="Custom", menu=custom_menu)
-
     def new_action(self):
         pass
 
     """ Alternatively, override create_menu:
-    def create_menu(self, master):
+    def create_menu(self, main, master):
         # Override to create a custom menu
         menu_bar = Menu(master)
         master.config(menu=menu_bar)
@@ -249,3 +242,11 @@ class MyCustomConsole(TextConsole):
 # Use the custom console
 text_console = MyCustomConsole(main, master)
 ```
+
+## Limitations
+
+*text\_console* does **not** support **Ctrl+C** to abort long‑running commands. Because the console is designed as an embeddable in-process API playground within a Tkinter process, it cannot leverage **multiprocessing** to provide real interrupt semantics, which would fork a separate Python environment, breaking the API. Likewise, **multithreading** cannot forcibly terminate an executing function due to Python’s **Global Interpreter Lock (GIL)** and the absence of a built-in thread‑kill API. Furthermore, Tkinter itself offers no mechanism to cancel an in‑progress widget callback or command/code evaluation and it runs inside an event loop rather than the standard Python REPL. Consequently, users must wait for blocking operations to finish.
+
+## License
+
+EUPL-1.2 License - See [LICENSE](LICENSE) for details.

text_console-2.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "text_console"
+description = "A customizable Tkinter-based text console widget, in which a user types in commands to be sent to the Python interpreter."
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "EUPL-1.2"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Ircama" },
+]
+requires-python = ">=3.9"
+keywords = ["shell", "console", "tkinter"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/Ircama/text_console"
+Documentation = "https://ircama.github.io/text_console"
+
+[project.scripts]
+text_console = "text_console.__main__:main"
+
+[tool.setuptools]
+packages = ["text_console"]
+
+[tool.setuptools.dynamic]
+version = { attr = "text_console.__version__.__version__" }

text_console-2.1.0/setup.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Legacy setup.py shim.
+
+The packaging metadata has been moved to ``pyproject.toml`` (PEP 621).
+This file is kept only for backwards compatibility with tools that
+still invoke ``python setup.py``. All actual configuration now lives
+in ``pyproject.toml``.
+"""
+
+from setuptools import setup
+
+setup()

text_console-2.1.0/text_console/__version__.py

@@ -0,0 +1 @@
+__version__ = "2.1.0"

{text_console-2.0.7 → text_console-2.1.0}/text_console.egg-info/PKG-INFO

@@ -1,31 +1,28 @@
 Metadata-Version: 2.4
 Name: text_console
-Version: 2.0.7
-Summary: ('A customizable Tkinter-based text console widget, in which a user types in commands to be sent to the Python interpreter.',)
-Home-page: https://github.com/Ircama/text_console
+Version: 2.1.0
+Summary: A customizable Tkinter-based text console widget, in which a user types in commands to be sent to the Python interpreter.
 Author: Ircama
-License: EUPL-1.2
-Keywords: shell console tkinter
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Programming Language :: Python :: 3 :: Only
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/Ircama/text_console
+Project-URL: Documentation, https://ircama.github.io/text_console
+Keywords: shell,console,tkinter
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
-Requires-Python: >3.6
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-python
-Dynamic: summary
 
 # text_console
 
@@ -119,5 +116,163 @@ In the History Panel:
 |Double-click|Recall command to main window from history panel|
 | Esc               | In history panel: Close Command History panel / Cancel search|
 
+## Installation
+
+Requires Python 3.9 or later (including Python 3.14).
+
+```bash
+pip install text-console
+```
+
+## Playground
+
+```
+python -m text_console
+```
+
+Available options:
+
+```
+Python Console [-h] [-V]
+
+options:
+  -h, --help     show this help message and exit
+  -V, --version  Print version and exit
+
+A customizable Tkinter-based text console widget.
+```
+
+### Running the pre-built GUI executable
+
+The *text_console.zip* archive in the [Releases](https://github.com/Ircama/text_console/releases/latest) folder incudes the *text_console.exe* executable asset; the ZIP archive is auto-generated by a [GitHub Action](https://github.com/Ircama/text_console/blob/main/.github/workflows/build.yml). *text_console.exe* is a Windows GUI that can be directly executed.
+
+### Basic usage with default settings
+
+```python
+import tkinter as tk
+from text_console import TextConsole
+
+class TkConsole(tk.Tk):
+    def __init__(self):
+        super().__init__()
+        self.title("Python Console")
+        self.geometry("800x400")
+
+        # Initialize the TextConsole widget
+        console = TextConsole(self, self)
+        console.pack(fill='both', expand=True)
+
+        # Configure grid resizing for the main window
+        self.grid_rowconfigure(0, weight=1)
+        self.grid_columnconfigure(0, weight=1)
+
+
+app = TkConsole()
+app.mainloop()
+```
+
+### Invoking TextConsole from a Master widget
+
+```python
+import tkinter as tk
+from text_console import TextConsole
+
+class TkConsole(tk.Tk):
+    def __init__(self):
+        super().__init__()
+        self.title("Python Console")
+        self.geometry("100x70")
+
+        # Add a button to launch the TextConsole
+        run_console_button = tk.Button(
+            self, 
+            text="Debug Console", 
+            command=self.run_text_console
+        )
+        run_console_button.pack(pady=20)  # Add some spacing around the button
+
+        # Configure grid resizing for the main window
+        self.grid_rowconfigure(0, weight=1)
+        self.grid_columnconfigure(0, weight=1)
+
+    def run_text_console(self):
+        """Launches the TextConsole in a new Toplevel window."""
+        console_window = tk.Toplevel(self)
+        console_window.title("Debug Console")
+        console_window.geometry("800x400")
+
+        # Initialize the TextConsole widget
+        console = TextConsole(self, console_window)
+        console.pack(fill='both', expand=True)
+
+app = TkConsole()
+app.mainloop()
+```
+
+### Customized console through subclassing
+
+```python
+from text_console import TextConsole
+
+class MyCustomConsole(TextConsole):
+
+    # Override class attributes
+    history_file = "my_custom_history.txt"
+
+    console_locals = {
+        "my_var": 42,
+        "my_function": lambda x: x * 2
+    }
+
+    context_menu_items = [
+        ("Custom Action", "custom_action"),
+        "-",  # separator
+        ("Clear", "clear")
+    ]
+
+    show_about_message = "My Custom Console v1.0"
+    show_help_content = "This is my custom console help content"
+    
+    def custom_action(self):
+        print("Custom action executed!")
+    
+    def create_menu(self, main, master):
+        # Extend the menu created by the base class
+        super().create_menu(main, master)
+        
+        # Add "Web Site" to the Help menu
+        menu_bar = master.nametowidget(master.cget('menu'))  # Get the menu widget
+        help_menu = list(menu_bar.children.values())[2]  # Access the Help menu (third = 2)
+        help_menu.insert_command(
+            help_menu.index("end"),
+            label="Web Site",
+            command=self.new_action
+        )
+
+    def new_action(self):
+        pass
+
+    """ Alternatively, override create_menu:
+    def create_menu(self, main, master):
+        # Override to create a custom menu
+        menu_bar = Menu(master)
+        master.config(menu=menu_bar)
+        
+        # Custom menu items
+        custom_menu = Menu(menu_bar, tearoff=0)
+        custom_menu.add_command(label="My Action", command=self.custom_action)
+        menu_bar.add_cascade(label="Custom", menu=custom_menu)
+    """
+
+
+# Use the custom console
+text_console = MyCustomConsole(main, master)
+```
+
+## Limitations
+
+*text\_console* does **not** support **Ctrl+C** to abort long‑running commands. Because the console is designed as an embeddable in-process API playground within a Tkinter process, it cannot leverage **multiprocessing** to provide real interrupt semantics, which would fork a separate Python environment, breaking the API. Likewise, **multithreading** cannot forcibly terminate an executing function due to Python’s **Global Interpreter Lock (GIL)** and the absence of a built-in thread‑kill API. Furthermore, Tkinter itself offers no mechanism to cancel an in‑progress widget callback or command/code evaluation and it runs inside an event loop rather than the standard Python REPL. Consequently, users must wait for blocking operations to finish.
+
+## License
 
-Full information and usage details at the [text_console GitHub repository](https://github.com/Ircama/text_console).
+EUPL-1.2 License - See [LICENSE](LICENSE) for details.

{text_console-2.0.7 → text_console-2.1.0}/text_console.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 LICENSE
 README.md
+pyproject.toml
 setup.py
 text_console/__init__.py
 text_console/__main__.py

text_console-2.0.7/LICENSE

@@ -1,134 +0,0 @@
-Copyright (c) 2024-2025 Ircama, EUPL-1.1
-
-Corresponding SPDX licence: European Union Public License 1.1
-
-Licence ID: EUPL-1.1
-
-See also:
-https://joinup.ec.europa.eu/sites/default/files/custom-page/attachment/eupl1.1…
-https://opensource.org/licenses/EUPL-1.1
-https://joinup.ec.europa.eu/software/page/eupl/licence-eupl
-
-Licence text
-
-European Union Public Licence V. 1.1
-
-EUPL (c) the European Community 2007
-
-This European Union Public Licence (the "EUPL") applies to the Work or Software (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
-
-The Original Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Original Work:
-
-Licensed under the EUPL V.1.1
-
-or has expressed by any other mean his willingness to license under the EUPL.
-
-1. Definitions
-In this Licence, the following terms have the following meaning:
-
-- The Licence: this Licence.
-- The Original Work or the Software: the software distributed and/or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
-- Derivative Works: the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
-- The Work: the Original Work and/or its Derivative Works.
-- The Source Code: the human-readable form of the Work which is the most convenient for people to study and modify.
-- The Executable Code: any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
-- The Licensor: the natural or legal person that distributes and/or communicates the Work under the Licence.
-- Contributor(s): any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
-- The Licensee or "You": any natural or legal person who makes any usage of the Software under the terms of the Licence.
-- Distribution and/or Communication: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, on-line or off-line, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
-2. Scope of the rights granted by the Licence
-The Licensor hereby grants You a world-wide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
-
-- use the Work in any circumstance and for all usage,
-- reproduce the Work,
-- modify the Original Work, and make Derivative Works based upon the Work,
-- communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
-- distribute the Work or copies thereof,
-- lend and rent the Work or copies thereof,
-- sub-license rights in the Work or copies thereof.
-Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
-
-In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
-
-The Licensor grants to the Licensee royalty-free, non exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
-
-3. Communication of the Source Code
-The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute and/or communicate the Work.
-
-4. Limitations on copyright
-Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Original Work or Software, of the exhaustion of those rights or of other applicable limitations thereto.
-
-5. Obligations of the Licensee
-The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
-
-Attribution right: the Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes and/or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
-
-Copyleft clause: If the Licensee distributes and/or communicates copies of the Original Works or Derivative Works based upon the Original Work, this Distribution and/or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
-
-Compatibility clause: If the Licensee Distributes and/or Communicates Derivative Works or copies thereof based upon both the Original Work and another work licensed under a Compatible Licence, this Distribution and/or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, "Compatible Licence," refers to the licences listed in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
-
-Provision of Source Code: When distributing and/or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute and/or communicate the Work.
-
-Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the copyright notice.
-
-6. Chain of Authorship
-The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
-
-Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
-
-Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
-
-7. Disclaimer of Warranty
-The Work is a work in progress, which is continuously improved by numerous contributors. It is not a finished work and may therefore contain defects or "bugs" inherent to this type of software development.
-
-For the above reason, the Work is provided under the Licence on an "as is" basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
-
-This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
-
-8. Disclaimer of Liability
-Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
-
-9. Additional agreements
-While distributing the Original Work or Derivative Works, You may choose to conclude an additional agreement to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or services consistent with this Licence. However, in accepting such obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any such warranty or additional liability.
-
-10. Acceptance of the Licence
-The provisions of this Licence can be accepted by clicking on an icon "I agree" placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
-
-Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution and/or Communication by You of the Work or copies thereof.
-
-11. Information to the public
-In case of any Distribution and/or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
-
-12. Termination of the Licence
-The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence. Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
-
-13. Miscellaneous
-Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work licensed hereunder.
-
-If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed and/or reformed so as necessary to make it valid and enforceable.
-
-The European Commission may publish other linguistic versions and/or new versions of this Licence, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
-
-All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
-
-14. Jurisdiction
-Any litigation resulting from the interpretation of this License, arising between the European Commission, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Communities, as laid down in article 238 of the Treaty establishing the European Community.
-
-Any litigation arising between Parties, other than the European Commission, and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
-
-15. Applicable Law
-This Licence shall be governed by the law of the European Union country where the Licensor resides or has his registered office.
-
-This licence shall be governed by the Belgian law if:
-
-- a litigation arises between the European Commission, as a Licensor, and any Licensee;
-- the Licensor, other than the European Commission, has no residence or registered office inside a European Union country.
-Appendix
-
-"Compatible Licences" according to article 5 EUPL are:
-
-- GNU General Public License (GNU GPL) v. 2
-- Open Software License (OSL) v. 2.1, v. 3.0
-- Common Public License v. 1.0
-- Eclipse Public License v. 1.0
-- Cecill v. 2.0

text_console-2.0.7/setup.py

@@ -1,81 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-from setuptools import setup, find_packages
-import re
-import os
-import sys
-
-import json
-from urllib import request
-from pkg_resources import parse_version
-
-###########################################################################
-
-END_OF_INTRODUCTION = '## Installation'
-
-EPILOGUE = '''
-Full information and usage details at the [text_console GitHub repository](https://github.com/Ircama/text_console).
-'''
-
-DESCRIPTION = (
-        "A customizable Tkinter-based text console widget,"
-        " in which a user types in commands"
-        " to be sent to the Python interpreter."
-    ),
-
-PACKAGE_NAME = "text_console"
-
-VERSIONFILE = "text_console/__version__.py"
-
-###########################################################################
-
-def versions(pkg_name, site):
-    url = 'https://' + site + '.python.org/pypi/' + pkg_name + '/json'
-    try:
-        releases = json.loads(request.urlopen(url).read())['releases']
-    except Exception as e:
-        print("Error while getting data from URL '" + url + "': " + e)
-        return []
-    return sorted(releases, key=parse_version, reverse=True)
-
-with open("README.md", "r") as readme:
-    long_description = readme.read()
-
-build = ''
-verstrline = open(VERSIONFILE, "rt").read()
-VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"
-mo = re.search(VSRE, verstrline, re.M)
-if mo:
-    verstr = mo.group(1)
-else:
-    raise RuntimeError("Unable to find version string in %s." % (VERSIONFILE,))
-        
-
-setup(
-    name=PACKAGE_NAME,
-    version=verstr,
-    description=(DESCRIPTION),
-    long_description=long_description[
-        :long_description.find(END_OF_INTRODUCTION)] + EPILOGUE,
-    long_description_content_type="text/markdown",
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        'Programming Language :: Python :: 3 :: Only',
-        "Development Status :: 5 - Production/Stable",
-        "Operating System :: OS Independent",
-        "Intended Audience :: Developers",
-    ],
-    keywords=("shell console tkinter"),
-    author="Ircama",
-    url="https://github.com/Ircama/text_console",
-    license='EUPL-1.2',
-    packages=find_packages(),
-    entry_points={
-    'console_scripts': [
-        'text_console = text_console.__main__:main',
-    ]},
-    python_requires='>3.6'
-)

text_console-2.0.7/text_console/__version__.py

@@ -1 +0,0 @@
-__version__ = "2.0.7"