pax_global_header00006660000000000000000000000064145550403310014512gustar00rootroot0000000000000052 comment=c0b342177894e16e8be1e2c2e27b6da9543fb687 gitlike-commands-0.3.0/000077500000000000000000000000001455504033100147415ustar00rootroot00000000000000gitlike-commands-0.3.0/.codeclimate.yml000066400000000000000000000015221455504033100200130ustar00rootroot00000000000000--- 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.3.0/.github/000077500000000000000000000000001455504033100163015ustar00rootroot00000000000000gitlike-commands-0.3.0/.github/FUNDING.yml000066400000000000000000000012071455504033100201160ustar00rootroot00000000000000# 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.3.0/.github/dependabot.yml000066400000000000000000000004131455504033100211270ustar00rootroot00000000000000--- # 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.3.0/.github/workflows/000077500000000000000000000000001455504033100203365ustar00rootroot00000000000000gitlike-commands-0.3.0/.github/workflows/awesomebot.yml000066400000000000000000000006741455504033100232350ustar00rootroot00000000000000--- name: Check links in Readme on: push: branches: [ '*' ] pull_request: branches: [ '*' ] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - 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.3.0/.github/workflows/mega-linter.yml000066400000000000000000000035551455504033100232750ustar00rootroot00000000000000--- ########################### ########################### ## 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@v4 with: # 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: nvuillam/mega-linter@v7 env: VALIDATE_ALL_CODEBASE: false DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} REPOSITORY_KICS_DISABLE_ERRORS: true DISABLE_LINTERS: SPELL_CSPELL,MARKDOWN_MARKDOWN_LINK_CHECK,PYTHON_BANDIT,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@v4 with: name: Mega-Linter reports path: | report mega-linter.log gitlike-commands-0.3.0/.gitignore000066400000000000000000000034071455504033100167350ustar00rootroot00000000000000# 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.3.0/LICENSE000066400000000000000000000236761455504033100157640ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product 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 NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of 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 reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS gitlike-commands-0.3.0/README.md000066400000000000000000000037171455504033100162300ustar00rootroot00000000000000# gitlike-commands [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0/) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Funixorn%2Fgitlike-commands%2Fbadge%3Fref%3Dmain&style=plastic)](https://actions-badge.atrox.dev/unixorn/gitlike-commands/goto?ref=main) ![Awesomebot](https://github.com/unixorn/gitlike-commands/actions/workflows/awesomebot.yml/badge.svg) ![Megalinter](https://github.com/unixorn/gitlike-commands/actions/workflows/mega-linter.yml/badge.svg) [![Issue Count](https://codeclimate.com/github/unixorn/gitlike-commands/badges/issue_count.svg)](https://codeclimate.com/github/unixorn/gitlike-commands) ![PyPI - Format](https://img.shields.io/pypi/format/gitlike-commands?style=plastic) ## Background `gitlike-commands` is a python module for easily creating `git`-style subcommand handling. Refactored out of [thelogrus](https://github.com/unixorn/thelogrus/) so you don't have to import any modules that aren't part of the Python standard library. ## Usage `subcommand_driver` automatically figures out what name the script was called as, then looks for subcommands and runs them if found, passing in any command line options. So if you have a `foo` script in your `$PATH` as shown below ```python #!/usr/bin/env python3 from gitlike_commands import subcommand_driver if __name__ == '__main__': subcommand_driver() ``` 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: ```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.gitlike-commands-0.3.0/gitlike_commands/000077500000000000000000000000001455504033100202525ustar00rootroot00000000000000gitlike-commands-0.3.0/gitlike_commands/__init__.py000066400000000000000000000066571455504033100224010ustar00rootroot00000000000000#!/usr/bin/env python3 # # Copyright 2015-2022 Joe Block # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from shutil import which import os import subprocess import sys from importlib import metadata __version__ = metadata.version(__package__) def is_program(name): """ Search for a given program in $PATH, and return True if it exists and is executable. :param str name: Name of program to search for :returns: whether or not the program can be found in $PATH :rtype: bool """ return which(name) is not None def find_subcommand(args): """ Given a list ['foo','bar', 'baz'], attempts to create a command name in the format 'foo-bar-baz'. If that command exists, we run it. If it doesn't, we check to see if foo-bar exists, in which case we run `foo-bar baz`. We keep peeling chunks off the end of the command name and adding them to the argument list until we find a valid command name we can run. This allows us to easily make git-style command drivers where, for example we have a driver script, foo, and subcommand scripts foo-bar and foo-baz, and when the user types `foo bar foobar` we find the foo-bar script and run it as `foo-bar foobar` :param list|tuple args: list to try and convert to a command args pair :returns: command and arguments list :rtype: tuple :raises StandardError: if the args can't be matched to an executable subcommand """ command = None # If the only command we find is the first element of args, we've found # the driver script itself and re-executing it will cause an infinite # loop, so don't bother examining the first element on its own. for i in range(len(args) - 1): command = "-".join(args[: (len(args) - i)]) command_arguments = args[len(args) - i :] if is_program(os.path.basename(command)): return (command, command_arguments) raise RuntimeError("Could not find a executable subcommand for %s" % " ".join(args)) def subcommand_driver(): """ Process the command line arguments and run the appropriate subcommand. We want to be able to do git-style handoffs to subcommands where if we do `foo blah foo bar` and the executable foo-blah-foo exists, we'll call it with the argument bar. We deliberately don't do anything with the arguments other than hand them off to the foo subcommand. Subcommands are responsible for their own argument parsing. """ try: (command, args) = find_subcommand(sys.argv) # If we can't construct a subcommand from sys.argv, it'll still be able # to find this driver script, and re-running ourself isn't useful. if os.path.basename(command) == sys.argv[0]: print("Could not find a subcommand for %s" % " ".join(sys.argv)) sys.exit(1) except Exception as e: print(str(e)) sys.exit(1) subprocess.check_call([command] + args) gitlike-commands-0.3.0/pyproject.toml000066400000000000000000000015071455504033100176600ustar00rootroot00000000000000[tool.poetry] name = "gitlike-commands" version = "0.3.0" description = "Makes driver scripts that enable git-like commands so that foo bar will run foo-bar" authors = ["Joe Block "] homepage = "https://github.com/unixorn/gitlike-commands" repository = "https://github.com/unixorn/gitlike-commands" readme = "README.md" license = "Apache-2.0" classifiers = [ "Topic :: System :: System Shells", "Topic :: Software Development :: Libraries :: Python Modules" ] [tool.poetry.dependencies] python = "^3.9" [tool.poetry.dev-dependencies] pytest = "^7.4" [tool.poetry.urls] "Bug Tracker" = "https://github.com/unixorn/gitlike-commands/issues" [build-system] requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" # [tool.poetry.scripts] # gitalike-demo = "gitlike_commands:subcommand_driver" gitlike-commands-0.3.0/tests/000077500000000000000000000000001455504033100161035ustar00rootroot00000000000000gitlike-commands-0.3.0/tests/__init__.py000066400000000000000000000000001455504033100202020ustar00rootroot00000000000000gitlike-commands-0.3.0/tests/test_gitlike_commands.py000066400000000000000000000001411455504033100230210ustar00rootroot00000000000000from gitlike_commands import __version__ def test_version(): assert __version__ == "0.2.0"