dev-shell 0.9.1__tar.gz → 0.10.0__tar.gz

{dev_shell-0.9.1 → dev_shell-0.10.0}/.github/workflows/tests.yml

@@ -1,5 +1,6 @@
-
 name: tests
+permissions:
+  contents: read
 
 on:
   push:
@@ -11,11 +12,12 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.13", "3.12", "3.11"]
+        python-version: ["3.14", "3.13", "3.12"]
+        os: [ubuntu-latest, macos-latest] # TODO: windows-latest
+    runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
       run: |
@@ -25,13 +27,19 @@ jobs:
         git checkout $GITHUB_SHA || (git fetch && git checkout $GITHUB_SHA)
 
     - name: 'Set up Python ${{ matrix.python-version }}'
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@main
       # https://github.com/marketplace/actions/setup-python
       with:
         python-version: '${{ matrix.python-version }}'
         cache: 'pip' # caching pip dependencies
         cache-dependency-path: '**/requirements.*.txt'
 
+    - name: Install uv and set the Python version
+      # https://docs.astral.sh/uv/guides/integration/github/#multiple-python-versions
+      uses: astral-sh/setup-uv@main
+      with:
+        python-version: ${{ matrix.python-version }}
+
     - name: 'Bootstrap app venv'
       # The first CLI call will create the .venv
       run: |
@@ -49,9 +57,11 @@ jobs:
         ./devshell.py coverage
 
     - name: 'Upload coverage report'
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@main
       # https://github.com/marketplace/actions/codecov
       with:
+        # https://docs.codecov.com/docs/codecov-tokens#example-github-actions--official-codecov-action
+        token: ${{ secrets.CODECOV_TOKEN }}
         fail_ci_if_error: false
         verbose: true
 

{dev_shell-0.9.1 → dev_shell-0.10.0}/.gitignore

@@ -7,7 +7,9 @@ __pycache__
 *.orig
 
 !.github
+!.run
 !.editorconfig
-!.flake8
 !.gitignore
+!.pre-commit-config.yaml
+!.pre-commit-hooks.yaml
 !.gitkeep

dev_shell-0.10.0/.run/Template Python tests.run.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="true" type="tests" factoryName="Unittests">
+    <module name="dev-shell" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="$PROJECT_DIR$/.venv/bin/python" />
+    <option name="SDK_NAME" value="Python 3.10 (dev-shell)" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="IS_MODULE_SDK" value="false" />
+    <option name="ADD_CONTENT_ROOTS" value="false" />
+    <option name="ADD_SOURCE_ROOTS" value="false" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="RUN_TOOL" value="" />
+    <option name="_new_pattern" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;&quot;" />
+    <option name="_new_target" value="&quot;&quot;" />
+    <option name="_new_targetType" value="&quot;PATH&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

dev_shell-0.10.0/.run/Unittests __all__.run.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Unittests **all**" type="tests" factoryName="Unittests">
+    <module name="dev-shell" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="$PROJECT_DIR$/.venv/bin/python" />
+    <option name="SDK_NAME" value="Python 3.10 (dev-shell)" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="IS_MODULE_SDK" value="false" />
+    <option name="ADD_CONTENT_ROOTS" value="false" />
+    <option name="ADD_SOURCE_ROOTS" value="false" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="RUN_TOOL" value="" />
+    <option name="_new_pattern" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;&quot;" />
+    <option name="_new_target" value="&quot;&quot;" />
+    <option name="_new_targetType" value="&quot;CUSTOM&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

{dev_shell-0.9.1 → dev_shell-0.10.0}/PKG-INFO

@@ -1,16 +1,19 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dev-shell
-Version: 0.9.1
+Version: 0.10.0
 Summary: Developer shell for easy startup...
-Author-email: Jens Diemer <dev-shell@jensdiemer.de>
-License: GPL-3.0-or-later
 Project-URL: Documentation, https://github.com/jedie/dev-shell
 Project-URL: Source, https://github.com/jedie/dev-shell
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
+Author-email: Jens Diemer <dev-shell@jensdiemer.de>
+License: GPL-3.0-or-later
 License-File: LICENSE
-Requires-Dist: cmd2
+Requires-Python: >=3.12
 Requires-Dist: cli-base-utilities
+Requires-Dist: cmd2
+Requires-Dist: gnureadline; sys_platform != 'win32'
+Requires-Dist: pyreadline3; sys_platform == 'win32'
+Requires-Dist: rich
+Description-Content-Type: text/markdown
 
 # A "dev-shell" for Python projects ;)
 
@@ -33,95 +36,65 @@ Run Tests? Just start the script and call the "run test command".
 
 The "dev-shell" is the base to create a CLI and a shell. It also shows how to make a project bootstrap as simply as possible, e.g.:
 
+
+At least `uv` is needed. Install e.g.: via pipx:
 ```bash
-~$ git clone https://github.com/jedie/dev-shell.git
-~$ cd dev-shell
-~/dev-shell$ ./devshell.py test
+apt-get install pipx
+pipx install uv
 ```
 
+Clone the project and just start the CLI help commands.
+A virtual environment will be created/updated automatically.
 
-## How it works
-
-First start of the Python script [./devshell.py](https://github.com/jedie/dev-shell/blob/main/devshell.py) will bootstrap:
+```bash
+~$ git clone https://github.com/jedie/dev-shell.git
+~$ cd dev-shell
+~/dev-shell$ devshell.py --help
+~/dev-shell$ devshell.py test
+```
 
-* Generate a Python virtual environment (in short: `venv`)
-* Install poetry
-* Install project dependencies and the project himself
 
 The output on first bootstrap start looks like:
 
 ```bash
 ~/dev-shell$ ./devshell.py
-Create venv here: ~/dev-shell/.venv
-Collecting pip
-...
-Successfully installed pip-21.0.1
-Collecting poetry
-...
-Installing dependencies from lock file
-
-Package operations: 31 installs, 1 update, 0 removals
-
-...
-
-Installing the current project: dev-shell (0.0.1alpha0)
 
+Developer shell - dev_shell - v0.10.0
 
-+ .venv/bin/python .venv/bin/devshell
-
-
-Developer shell - dev_shell - v0.2.0
-
-
-Documented commands (use 'help -v' for verbose/'help <topic>' for details):
 
 dev-shell commands
-==================
-fix_code_style  linting  list_venv_packages  publish  test  update
+──────────────────
+check_code_style  fix_code_style  list_venv_packages  pyupgrade  update
+coverage          install         publish             test       version
 
-...
+Uncategorized Commands
+──────────────────────
+alias  help  history  macro  quit  set  shortcuts
 
 (dev_shell) quit
 ~/dev-shell$
 ```
 
-The first bootstrap start takes a few seconds. Each later startup detects the existing virtualenv and is very fast:
-
-```bash
-~/dev-shell$ ./devshell.py
-
-Developer shell - dev_shell - v0.2.0
-
-(dev_shell) help
-```
-
-Info: The `.venv` will be automatically updated via `poetry install` call if the `uv.lock` file has been changed.
-
-A call with `--update` will force to call some create/update steps, e.g.:
-
-```bash
-~/dev-shell$ ./devshell.py --update
-```
-
-You can also just delete `/.venv/` and start `devshell.py` again ;)
-
-(Using `--update` is not to be confused with the call of "update" command.)
-
 
 ## compatibility
 
 | dev-shell version | OS                      | Python version      |
 |-------------------|-------------------------|---------------------|
+| >=v0.10.0         | Linux + MacOS + Windows | 3.14, 3.13, 3.12    |
 | >=v0.7.0          | Linux + MacOS + Windows | 3.11, 3.10, 3.9     |
 | >=v0.5.0          | Linux + MacOS + Windows | 3.10, 3.9, 3.8, 3.7 |
 | >=v0.0.1          | Linux + MacOS + Windows | 3.9, 3.8, 3.7       |
 
-See also github test configuration: [.github/workflows/test.yml](https://github.com/jedie/dev-shell/blob/main/.github/workflows/test.yml)
+See also:
+* github test configuration: [.github/workflows/test.yml](https://github.com/jedie/dev-shell/blob/main/.github/workflows/test.yml)
+* Nox configuration: [noxfile.py](https://github.com/jedie/dev-shell/blob/main/noxfile.py)
 
 ## History
 
 * [*dev*](https://github.com/jedie/dev-shell/compare/v0.8.0...main)
   * TBC
+* [0.10.0 - 2026-02-10](https://github.com/jedie/dev-shell/compare/v0.9.1...v0.10.0)
+  * Modernize codebase
 * [0.9.1 - 2025-03-11](https://github.com/jedie/dev-shell/compare/v0.9.0...v0.9.1)
   * Fix usage as package in external projects
 * [0.9.0 - 2025-03-11](https://github.com/jedie/dev-shell/compare/v0.8.0...v0.9.0)

{dev_shell-0.9.1 → dev_shell-0.10.0}/README.md

@@ -19,95 +19,65 @@ Run Tests? Just start the script and call the "run test command".
 
 The "dev-shell" is the base to create a CLI and a shell. It also shows how to make a project bootstrap as simply as possible, e.g.:
 
+
+At least `uv` is needed. Install e.g.: via pipx:
 ```bash
-~$ git clone https://github.com/jedie/dev-shell.git
-~$ cd dev-shell
-~/dev-shell$ ./devshell.py test
+apt-get install pipx
+pipx install uv
 ```
 
+Clone the project and just start the CLI help commands.
+A virtual environment will be created/updated automatically.
 
-## How it works
-
-First start of the Python script [./devshell.py](https://github.com/jedie/dev-shell/blob/main/devshell.py) will bootstrap:
+```bash
+~$ git clone https://github.com/jedie/dev-shell.git
+~$ cd dev-shell
+~/dev-shell$ devshell.py --help
+~/dev-shell$ devshell.py test
+```
 
-* Generate a Python virtual environment (in short: `venv`)
-* Install poetry
-* Install project dependencies and the project himself
 
 The output on first bootstrap start looks like:
 
 ```bash
 ~/dev-shell$ ./devshell.py
-Create venv here: ~/dev-shell/.venv
-Collecting pip
-...
-Successfully installed pip-21.0.1
-Collecting poetry
-...
-Installing dependencies from lock file
-
-Package operations: 31 installs, 1 update, 0 removals
-
-...
-
-Installing the current project: dev-shell (0.0.1alpha0)
-
-
-+ .venv/bin/python .venv/bin/devshell
-
-
-Developer shell - dev_shell - v0.2.0
 
+Developer shell - dev_shell - v0.10.0
 
-Documented commands (use 'help -v' for verbose/'help <topic>' for details):
 
 dev-shell commands
-==================
-fix_code_style  linting  list_venv_packages  publish  test  update
+──────────────────
+check_code_style  fix_code_style  list_venv_packages  pyupgrade  update
+coverage          install         publish             test       version
 
-...
+Uncategorized Commands
+──────────────────────
+alias  help  history  macro  quit  set  shortcuts
 
 (dev_shell) quit
 ~/dev-shell$
 ```
 
-The first bootstrap start takes a few seconds. Each later startup detects the existing virtualenv and is very fast:
-
-```bash
-~/dev-shell$ ./devshell.py
-
-Developer shell - dev_shell - v0.2.0
-
-(dev_shell) help
-```
-
-Info: The `.venv` will be automatically updated via `poetry install` call if the `uv.lock` file has been changed.
-
-A call with `--update` will force to call some create/update steps, e.g.:
-
-```bash
-~/dev-shell$ ./devshell.py --update
-```
-
-You can also just delete `/.venv/` and start `devshell.py` again ;)
-
-(Using `--update` is not to be confused with the call of "update" command.)
-
 
 ## compatibility
 
 | dev-shell version | OS                      | Python version      |
 |-------------------|-------------------------|---------------------|
+| >=v0.10.0         | Linux + MacOS + Windows | 3.14, 3.13, 3.12    |
 | >=v0.7.0          | Linux + MacOS + Windows | 3.11, 3.10, 3.9     |
 | >=v0.5.0          | Linux + MacOS + Windows | 3.10, 3.9, 3.8, 3.7 |
 | >=v0.0.1          | Linux + MacOS + Windows | 3.9, 3.8, 3.7       |
 
-See also github test configuration: [.github/workflows/test.yml](https://github.com/jedie/dev-shell/blob/main/.github/workflows/test.yml)
+See also:
+* github test configuration: [.github/workflows/test.yml](https://github.com/jedie/dev-shell/blob/main/.github/workflows/test.yml)
+* Nox configuration: [noxfile.py](https://github.com/jedie/dev-shell/blob/main/noxfile.py)
 
 ## History
 
 * [*dev*](https://github.com/jedie/dev-shell/compare/v0.8.0...main)
   * TBC
+* [0.10.0 - 2026-02-10](https://github.com/jedie/dev-shell/compare/v0.9.1...v0.10.0)
+  * Modernize codebase
 * [0.9.1 - 2025-03-11](https://github.com/jedie/dev-shell/compare/v0.9.0...v0.9.1)
   * Fix usage as package in external projects
 * [0.9.0 - 2025-03-11](https://github.com/jedie/dev-shell/compare/v0.8.0...v0.9.0)

{dev_shell-0.9.1 → dev_shell-0.10.0}/dev_shell/__init__.py

@@ -4,5 +4,5 @@ Developer shell for easy startup...
 """
 
 # See https://packaging.python.org/en/latest/specifications/version-specifiers/
-__version__ = '0.9.1'
+__version__ = '0.10.0'
 __author__ = 'Jens Diemer <dev-shell@jensdiemer.de>'

{dev_shell-0.9.1 → dev_shell-0.10.0}/dev_shell/__main__.py

@@ -3,8 +3,8 @@ Allow dev_shell to be executable
 through `python -m dev_shell`.
 """
 
-from dev_shell.dev_shell_app import devshell_cmdloop
+from dev_shell.dev_shell_app import main
 
 
 if __name__ == '__main__':
-    devshell_cmdloop()
+    main()

{dev_shell-0.9.1 → dev_shell-0.10.0}/dev_shell/base_cmd2_app.py

@@ -1,12 +1,12 @@
 import os
+import shlex
 import sys
 from pathlib import Path
 
-import cmd2 as cmd2
+import cmd2
 
 from dev_shell.config import DevShellConfig
 from dev_shell.utils.colorful import bright_blue, bright_yellow
-from dev_shell.utils.subprocess_utils import argv2str
 
 
 class DevShellBaseApp(cmd2.Cmd):
@@ -14,55 +14,34 @@ class DevShellBaseApp(cmd2.Cmd):
     Base cmd2 App with some gimmicks ;)
     """
 
+    # Remove some default cmd2 commands:
+    delattr(cmd2.Cmd, 'do_edit')
+    delattr(cmd2.Cmd, 'do_shell')
+    delattr(cmd2.Cmd, 'do_run_script')
+    delattr(cmd2.Cmd, 'do_run_pyscript')
+
     def __init__(self, *args, config: DevShellConfig, **kwargs):
-        kwargs.update(dict(
-            persistent_history_file='.history',
-            allow_cli_args=False
-        ))
+        kwargs.update(dict(persistent_history_file='.history', allow_cli_args=False))
         super().__init__(*args, **kwargs)
 
         self.config = config
 
-        self.intro = (
-            f'\n\nDeveloper shell - {bright_yellow(config.package_path.name)} - v{config.version}\n'
-        )
+        self.intro = f'\n\nDeveloper shell - {bright_yellow(config.package_path.name)} - v{config.version}\n'
         self.prompt = f'\n({bright_blue(config.package_path.name)}) '
 
-        # work-a-round: https://github.com/python-cmd2/cmd2/issues/1072
-        args = sys.argv[1:]
-        if args:
-            # CLI usage => execute command and exit
-            self.intro = None
-            command = argv2str(args)
-            self._startup_commands = [command]
-        else:
-            self._startup_commands = ['help']
-
         # Set aliases:
-        self.aliases.update({
-            'q': 'quit',
-        })
+        self.aliases.update(
+            {
+                'q': 'quit',
+                '--help': 'help',  # Support --help as alias for help
+            }
+        )
 
         # Display Tracebacks on errors:
         self.debug = True
 
         self.update_path()
 
-    def onecmd(self, *args, **kwargs):
-        """
-        1. Exit cmdloop if shell was used as CLI ;)
-        2. Pass sys.exit() code
-        """
-        try:
-            stop = super().onecmd(*args, **kwargs)
-        except SystemExit as exit_code:
-            # Pass the sys.exit() code
-            # See also: https://github.com/python-cmd2/cmd2/pull/1076
-            self.exit_code = exit_code
-            stop = True
-
-        return stop
-
     def update_path(self):
         """
         Add our .venv/bin/ directory into PATH at first position.
@@ -80,7 +59,7 @@ def run_cmd2_app(app: cmd2.Cmd) -> None:
     """
     if len(sys.argv) > 1:
         # CLI usage => run only one command and then exit
-        app.onecmd_plus_hooks(line=argv2str(sys.argv[1:]))
+        app.onecmd_plus_hooks(line=shlex.join(sys.argv[1:]))
         exit_code = app.exit_code
     else:
         exit_code = app.cmdloop()

dev_shell-0.10.0/dev_shell/bootstrap-source.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+"""
+developer shell
+~~~~~~~~~~~~~~~
+
+Just call this file, and the magic happens ;)
+
+The `uv` tool is required to run the development CLI.
+
+e.g.: Install `uv` via `pipx`
+    apt install pipx
+    pipx install uv
+
+This file is from: https://pypi.org/project/dev-shell/
+Source: https://github.com/jedie/dev-shell/blob/main/devshell.py
+
+:copyleft: 2021-2024 by Jens Diemer
+:license: GNU GPL v3 or above
+"""
+
+import os
+import shlex
+import shutil
+import signal
+import subprocess
+import sys
+from pathlib import Path
+
+
+assert sys.version_info >= (3, 12), f'Python version {sys.version_info} is too old!'
+
+
+BASE_PATH = Path(__file__).parent.resolve()
+
+# Create and use  "<project-directory>/.venv/" for virtualenv:
+VIRTUAL_ENV = str(BASE_PATH / '.venv')
+
+
+def print_uv_error_and_exit():
+    print('\nError: "uv" command not found in PATH. Please install "uv" first!\n')
+    print('Hint:')
+    print('\tapt-get install pipx\n')
+    print('\tpipx install uv\n')
+    sys.exit(1)
+
+
+def verbose_check_call(*popen_args):
+    print(f'\n+ {shlex.join(str(arg) for arg in popen_args)}\n')
+    env = {
+        'VIRTUAL_ENV': VIRTUAL_ENV,
+        'UV_VENV': VIRTUAL_ENV,
+        **os.environ,
+    }
+    return subprocess.check_call(
+        popen_args,
+        env=env,
+        cwd=BASE_PATH,  # Needed if called from other working directory
+    )
+
+
+def noop_signal_handler(signal_num, frame):
+    """
+    Signal handler that does nothing: Used to ignore "Ctrl-C" signals
+    """
+
+
+def main(argv):
+    uv_bin = shutil.which('uv')  # Ensure 'uv' is available in PATH
+    if not uv_bin:
+        print_uv_error_and_exit()
+
+    # The cmd2 shell should not abort on Ctrl-C => ignore "Interrupt from keyboard" signal:
+    signal.signal(signal.SIGINT, noop_signal_handler)
+
+    # Call our entry point CLI:
+    try:
+        verbose_check_call(uv_bin, 'run', '-m', 'dev_shell', *argv[1:])
+    except subprocess.CalledProcessError as err:
+        sys.exit(err.returncode)
+
+
+if __name__ == '__main__':
+    main(sys.argv)