gitlike-commands 0.3.1__tar.gz → 0.4.0__tar.gz

gitlike_commands-0.4.0/.codeclimate.yml

@@ -0,0 +1,55 @@
+---
+engines:
+  pep8:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - "python"
+  fixme:
+    enabled: true
+    exclude_paths:
+      - config/engines.yml
+  pep8:
+    enabled: true
+    checks:
+      E111:
+        enabled: false
+      E501:
+        enabled: false
+  markdownlint:
+    enabled: true
+    checks:
+      MD004:
+        enabled: false
+      MD007:
+        enabled: false
+      MD013:
+        enabled: false
+      MD026:
+        enabled: false
+      MD029:
+        enabled: false
+      MD033:
+        enabled: false
+      MD034:
+        enabled: false
+      MD038:
+        enabled: false
+  shellcheck:
+    enabled: true
+ratings:
+  paths:
+  - "bin/**/*"
+  - "**.py"
+exclude_paths:
+  - "**.md"
+  - .bundle/
+  - benchmarks/**/*
+  - build/
+  - dist/
+  - include/**/*
+  - lib/**/*
+  - License.md
+  - spec/**/*

gitlike_commands-0.4.0/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 132

gitlike_commands-0.4.0/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: unixorn
+open_collective: # Replace with a single Open Collective username
+ko_fi: unixorn
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

gitlike_commands-0.4.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+---
+# Use `allow` to specify which dependencies to maintain
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

gitlike_commands-0.4.0/.github/workflows/awesomebot.yml

@@ -0,0 +1,19 @@
+---
+name: Check links in Readme
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v7
+    - uses: docker://dkhamsing/awesome_bot:latest
+      with:
+        args: /github/workspace/README.md --allow 500,501,502,503,504,509,521 --allow-dupe --request-delay 1 --allow-redirect --white-list https://ipfs.io,slideshare,https://img.shields.io

gitlike_commands-0.4.0/.github/workflows/mega-linter.yml

@@ -0,0 +1,72 @@
+---
+###########################
+###########################
+## Linter GitHub Actions ##
+###########################
+###########################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [main]
+    # Remove the line above to run when pushing to main
+  pull_request:
+    branches: [main]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Megalint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: oxsecurity/megalinter/flavors/python@v10
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ACTION_ACTIONLINT_DISABLE_ERRORS: true
+          ACTION_ZIZMOR_DISABLE_ERRORS: true
+          PYTHON_FLAKE8_DISABLE_ERRORS: true
+          PYTHON_PYRIGHT_DISABLE_ERRORS: true
+          REPOSITORY_OSV_SCANNER_DISABLE_ERRORS: true
+          DISABLE_LINTERS: SPELL_CSPELL,PYTHON_BANDIT,PYTHON_BLACK,PYTHON_PYLINT,REPOSITORY_CHECKOV,REPOSITORY_TRIVY,REPOSITORY_GRYPE,SPELL_LYCHEE
+
+      # Upload Mega-Linter artifacts. They will be available on Github action page "Artifacts" section
+      - name: Archive production artifacts
+        if: ${{ success() || failure() }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: Mega-Linter reports
+          path: |
+            report
+            mega-linter.log

gitlike_commands-0.4.0/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/

gitlike_commands-0.4.0/.markdownlint.json

@@ -0,0 +1,5 @@
+{
+  "MD024": {
+    "siblings_only": true
+  }
+}

gitlike_commands-0.4.0/.mega-linter.yml

@@ -0,0 +1,2 @@
+ACTION_ZIZMOR_UNSECURED_ENV_VARIABLES:
+  - GITHUB_TOKEN

gitlike_commands-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: 'v0.17.1'
+    hooks:
+      - id: ruff
+        args: [--select, I, --fix]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

gitlike_commands-0.4.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "makefile.extensionOutputFolder": "./.vscode"
+}

gitlike_commands-0.4.0/ChangeLog.md

@@ -0,0 +1,110 @@
+# ChangeLog
+
+All notable changes to `gitlike-commands` are documented here, newest first.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [v0.4.0](#v040)
+    - [Features](#features)
+    - [Build tooling](#build-tooling)
+    - [Documentation](#documentation)
+    - [Tests](#tests)
+- [v0.3.1 — 2026-03-31](#v031-2026-03-31)
+    - [Build tooling](#build-tooling-1)
+    - [CI](#ci)
+- [v0.3.0 — 2024-01-26](#v030-2024-01-26)
+    - [Features](#features-1)
+    - [Build tooling](#build-tooling-2)
+    - [CI](#ci-1)
+- [v0.2.1 — 2022-06-13](#v021-2022-06-13)
+    - [Packaging](#packaging)
+    - [Documentation](#documentation-1)
+- [v0.1.0 — 2022-03-09](#v010-2022-03-09)
+    - [Features](#features-2)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## v0.4.0
+
+### Features
+
+- `subcommand_driver` now passes `stdin`, `stdout`, and `stderr` explicitly to
+  the subcommand it runs with `subprocess.check_call`, via a new
+  `_stream_target` helper. Streams with a real file descriptor (the normal CLI
+  case) pass through unchanged; streams without one (a `StringIO`, a
+  test-capture wrapper) fall back to inheriting the parent descriptor instead
+  of raising. For a normal invocation this matches the previous inherit-by-
+  default behavior; the helper hardens the fd-less case.
+
+### Build tooling
+
+- Finished the poetry-to-uv migration. `pyproject.toml` is now PEP 621:
+  `[project]` metadata with `requires-python = ">=3.9"`, dev dependencies
+  consolidated into a single `[dependency-groups]` dev group (`pytest`,
+  `pytest-cov`), and the build backend switched from `poetry-core` to
+  `hatchling`.
+- Added `pytest-cov` as a dev dependency.
+
+### Documentation
+
+- README `Usage` section documents the inherited `stdin`/`stdout`/`stderr`
+  behavior.
+- README scripts-entry example now shows the PEP 621 `[project.scripts]` form
+  alongside the poetry form.
+
+### Tests
+
+- Added unit tests covering `is_program`, `find_subcommand`, `_stream_target`,
+  and `subcommand_driver` (100% line coverage).
+- Removed the `test_version` placeholder test, which asserted a hardcoded
+  version string and had to be edited on every release.
+
+## v0.3.1 — 2026-03-31
+
+### Build tooling
+
+- Converted the project from poetry to uv.
+- Cut a release to pull in accumulated dependency updates.
+- Bumped the pytest requirement from `^7.4` to `^8.0`.
+
+### CI
+
+- Updated mega-linter and applied its fixer suggestions.
+
+## v0.3.0 — 2024-01-26
+
+### Features
+
+- Load the package version from installed metadata rather than hardcoding it.
+
+### Build tooling
+
+- Replaced `distutils` with `shutil` (removes the deprecated dependency).
+- Updated the pytest requirement from `^5.2` to `^7.4`.
+
+### CI
+
+- Updated megalinter to v7 and demoted KICS findings to warnings.
+
+## v0.2.1 — 2022-06-13
+
+### Packaging
+
+- Added classifier entries, license, and issue-tracker URL to `pyproject.toml`.
+
+### Documentation
+
+- Clarified the requirements for subcommands in the README.
+- Added a PyPI badge and cleaned up the license blurb.
+
+## v0.1.0 — 2022-03-09
+
+### Features
+
+- Initial release. Code refactored out of
+  [thelogrus](https://github.com/unixorn/thelogrus/) so consumers depend only on
+  the Python standard library.
+- `subcommand_driver`, `find_subcommand`, and `is_program` for building
+  git-style subcommand dispatch.

gitlike_commands-0.4.0/Dockerfile

@@ -0,0 +1,13 @@
+FROM unixorn/debian-py3
+
+RUN mkdir -p /data && \
+    mkdir -p /config && \
+    mkdir -p /usr/local/bin
+
+COPY tests/foo-bar /usr/local/bin
+COPY dist/*.whl /data
+RUN pip install --no-cache-dir --disable-pip-version-check /data/*.whl
+
+# Use bash -l so that we pick up the REQUESTS_CA_BUNDLE value from
+# /etc/profile.d/python-enable-all-ssl-certs.sh
+CMD ["bash", "-l"]

gitlike_commands-0.4.0/Makefile

@@ -0,0 +1,57 @@
+h: help
+help:
+	@echo "Options:"
+	@echo "format: Reformat all python files with ruff"
+	@echo "tests: Run tests with nosetest"
+	@echo "verbose_tests: Run tests with nosetest -v"
+
+docker: local
+f: format
+t: test
+i: image
+image: local
+
+format: format_code format_tests
+
+fix_python_imports:
+	ruff check --select I --fix gitlike_commands/*.py
+
+lint:
+	@echo "Linting with ruff"
+	ruff check gitlike_commands/*.py
+
+fixup:
+	@echo "Fixing up with ruff"
+	ruff check --fix --show-fixes gitlike_commands/*.py
+
+format_code: fix_python_imports lint fixup
+	ruff format gitlike_commands/*.py
+
+format_tests:
+	ruff format tests/*.py
+	ruff check --fix --show-fixes tests/*.py
+	ruff check --select I --fix tests/*.py
+
+tests: test
+test:
+	nosetests
+
+verbose_tests: verbose_test
+verbose_test:
+	nosetests -v
+
+wheel: clean format
+	uv build
+
+local: wheel
+	docker buildx build --load -t unixorn/gitlike-commands .
+
+fatimage: wheel
+	docker buildx build --platform linux/arm64,linux/amd64 --push -t unixorn/gitlike-commands .
+	make local
+
+clean:
+	rm -f dist/*
+
+fat:
+	make fatimage

gitlike_commands-0.4.0/OnDeck.md

@@ -0,0 +1 @@
+[![Code Climate](https://codeclimate.com/github/unixorn/gitlike-commands/badges/gpa.svg)](https://codeclimate.com/github/unixorn/gitlike-commands)

{gitlike_commands-0.3.1 → gitlike_commands-0.4.0}/PKG-INFO

@@ -1,27 +1,28 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: gitlike-commands
-Version: 0.3.1
+Version: 0.4.0
 Summary: Makes driver scripts that enable git-like commands so that foo bar will run foo-bar
-License: Apache-2.0
+Project-URL: Homepage, https://github.com/unixorn/gitlike-commands
+Project-URL: Repository, https://github.com/unixorn/gitlike-commands
+Project-URL: Bug Tracker, https://github.com/unixorn/gitlike-commands/issues
+Author-email: Joe Block <jpb@unixorn.net>
+License-Expression: Apache-2.0
 License-File: LICENSE
-Author: Joe Block
-Author-email: jpb@unixorn.net
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-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
 Classifier: Topic :: System :: System Shells
-Project-URL: Bug Tracker, https://github.com/unixorn/gitlike-commands/issues
-Project-URL: Homepage, https://github.com/unixorn/gitlike-commands
-Project-URL: Repository, https://github.com/unixorn/gitlike-commands
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [gitlike-commands](#gitlike-commands)
+  - [Background](#background)
+  - [Usage](#usage)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # gitlike-commands
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0/)
@@ -52,12 +53,21 @@ if __name__ == '__main__':
 
 Running `foo bar baz` will look for a `foo-bar-baz` script, and if present in your `$PATH`, run it. If there is no `foo-bar-baz`, it will look for `foo-bar`, and if it finds that, run `foo-bar baz`.
 
-If you're using poetry in your python project, you can add a gitlike driver as a scripts entry:
+You can add a gitlike driver as a scripts entry in your `pyproject.toml`. With a
+PEP 621 layout (uv, hatch, pdm, and other standards-based tools):
+
+```toml
+[project.scripts]
+gitalike-demo = "gitlike_commands:subcommand_driver"
+```
+
+Or, if your project still uses poetry:
 
 ```toml
 [tool.poetry.scripts]
 gitalike-demo = "gitlike_commands:subcommand_driver"
 ```
 
-The subcommands can be written in any language, the only requirements are that they are marked executable and follow the `foo-something` naming convention.
+The subcommand inherits the driver's `stdin`, `stdout`, and `stderr`, so piped input (`echo data | foo bar`), interactive prompts, and output all pass through to the subcommand unchanged.
 
+The subcommands can be written in any language, the only requirements are that they are marked executable and follow the `foo-something` naming convention.

{gitlike_commands-0.3.1 → gitlike_commands-0.4.0}/README.md

@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [gitlike-commands](#gitlike-commands)
+  - [Background](#background)
+  - [Usage](#usage)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # gitlike-commands
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0/)
@@ -28,11 +38,21 @@ if __name__ == '__main__':
 
 Running `foo bar baz` will look for a `foo-bar-baz` script, and if present in your `$PATH`, run it. If there is no `foo-bar-baz`, it will look for `foo-bar`, and if it finds that, run `foo-bar baz`.
 
-If you're using poetry in your python project, you can add a gitlike driver as a scripts entry:
+You can add a gitlike driver as a scripts entry in your `pyproject.toml`. With a
+PEP 621 layout (uv, hatch, pdm, and other standards-based tools):
+
+```toml
+[project.scripts]
+gitalike-demo = "gitlike_commands:subcommand_driver"
+```
+
+Or, if your project still uses poetry:
 
 ```toml
 [tool.poetry.scripts]
 gitalike-demo = "gitlike_commands:subcommand_driver"
 ```
 
+The subcommand inherits the driver's `stdin`, `stdout`, and `stderr`, so piped input (`echo data | foo bar`), interactive prompts, and output all pass through to the subcommand unchanged.
+
 The subcommands can be written in any language, the only requirements are that they are marked executable and follow the `foo-something` naming convention.