hypershell 2.6.4__tar.gz

hypershell-2.6.4/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

hypershell-2.6.4/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.3
+Name: hypershell
+Version: 2.6.4
+Summary: A cross-platform, high-throughput computing utility for processing shell commands over a distributed, asynchronous queue.
+License: Apache-2.0
+Keywords: distributed-computing,command-line-tool,shell-scripting,high-performance-computing,high-throughput-computing
+Author: Geoffrey Lentner
+Author-email: glentner@purdue.edu
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+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: Topic :: Utilities
+Provides-Extra: postgres
+Requires-Dist: cmdkit[toml] (>=2.7.7,<3.0.0)
+Requires-Dist: paramiko (>=3.4.0,<4.0.0)
+Requires-Dist: psycopg2 (>=2.9.9,<3.0.0) ; extra == "postgres"
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: sqlalchemy (>=2.0.29,<3.0.0)
+Requires-Dist: tomlkit (>=0.13.2,<0.14.0)
+Project-URL: Documentation, https://hypershell.readthedocs.io
+Project-URL: Homepage, https://hypershell.org
+Project-URL: Repository, https://github.com/hypershell/hypershell
+Description-Content-Type: text/x-rst
+
+HyperShell v2: Distributed Task Execution for HPC
+=================================================
+
+.. image:: https://img.shields.io/badge/license-Apache-blue.svg?style=flat
+    :target: https://www.apache.org/licenses/LICENSE-2.0
+    :alt: License
+
+.. image:: https://img.shields.io/github/v/release/hypershell/hypershell?sort=semver
+    :target: https://github.com/hypershell/hypershell/releases
+    :alt: Github Release
+
+.. image:: https://img.shields.io/badge/Python-3.9+-blue.svg
+    :target: https://www.python.org/downloads
+    :alt: Python Versions
+
+.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
+    :target: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
+    :alt: Code of Conduct
+
+.. image:: https://readthedocs.org/projects/hypershell/badge/?version=latest
+    :target: https://hypershell.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+|
+
+*HyperShell* is an elegant, cross-platform, high-throughput computing utility for
+processing shell commands over a distributed, asynchronous queue. It is a highly
+scalable workflow automation tool for *many-task* scenarios.
+
+Built on Python and tested on Linux, macOS, and Windows.
+
+Several tools offer similar functionality but not all together in a single tool with
+the user ergonomics we provide. Novel design elements include but are not limited to
+
+* **Cross-platform:** run on any platform where Python runs. In fact, the server and
+  client can run on different platforms in the same cluster.
+* **Client-server:** workloads do not need to be monolithic. Run the server as a
+  stand-alone service with SQLite or Postgres as a persistent database and dynamically
+  scale clients as needed.
+* **Staggered launch:** At the largest scales (1000s of nodes, 100k+ of workers),
+  the launch process can be challenging. Come up gradually to balance the workload.
+* **Database in-the-loop:** run in-memory for quick, ad-hoc workloads. Otherwise,
+  include a database for persistence, recovery when restarting, and search.
+
+
+Documentation
+-------------
+
+Documentation is available at `hypershell.readthedocs.io <https://hypershell.readthedocs.io>`_.
+For basic usage information on the command line use: ``hs --help``. For a more
+comprehensive usage guide on the command line you can view the manual page with 
+``man hs``.
+
+
+Contributions
+-------------
+
+Contributions are welcome. If you find bugs or have questions, open an *Issue* here.
+We've added a Code of Conduct recently, adapted from the
+`Contributor Covenant <https://www.contributor-covenant.org/>`_, version 2.0.
+
+
+Citation
+--------
+
+If *HyperShell* has helped in your research please consider citing us.
+
+.. code-block:: bibtex
+
+    @inproceedings{lentner_2022,
+        author = {Lentner, Geoffrey and Gorenstein, Lev},
+        title = {HyperShell v2: Distributed Task Execution for HPC},
+        year = {2022},
+        isbn = {9781450391610},
+        publisher = {Association for Computing Machinery},
+        url = {https://doi.org/10.1145/3491418.3535138},
+        doi = {10.1145/3491418.3535138},
+        booktitle = {Practice and Experience in Advanced Research Computing},
+        articleno = {80},
+        numpages = {3},
+        series = {PEARC '22}
+    }
+

hypershell-2.6.4/README.rst

@@ -0,0 +1,82 @@
+HyperShell v2: Distributed Task Execution for HPC
+=================================================
+
+.. image:: https://img.shields.io/badge/license-Apache-blue.svg?style=flat
+    :target: https://www.apache.org/licenses/LICENSE-2.0
+    :alt: License
+
+.. image:: https://img.shields.io/github/v/release/hypershell/hypershell?sort=semver
+    :target: https://github.com/hypershell/hypershell/releases
+    :alt: Github Release
+
+.. image:: https://img.shields.io/badge/Python-3.9+-blue.svg
+    :target: https://www.python.org/downloads
+    :alt: Python Versions
+
+.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
+    :target: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
+    :alt: Code of Conduct
+
+.. image:: https://readthedocs.org/projects/hypershell/badge/?version=latest
+    :target: https://hypershell.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+|
+
+*HyperShell* is an elegant, cross-platform, high-throughput computing utility for
+processing shell commands over a distributed, asynchronous queue. It is a highly
+scalable workflow automation tool for *many-task* scenarios.
+
+Built on Python and tested on Linux, macOS, and Windows.
+
+Several tools offer similar functionality but not all together in a single tool with
+the user ergonomics we provide. Novel design elements include but are not limited to
+
+* **Cross-platform:** run on any platform where Python runs. In fact, the server and
+  client can run on different platforms in the same cluster.
+* **Client-server:** workloads do not need to be monolithic. Run the server as a
+  stand-alone service with SQLite or Postgres as a persistent database and dynamically
+  scale clients as needed.
+* **Staggered launch:** At the largest scales (1000s of nodes, 100k+ of workers),
+  the launch process can be challenging. Come up gradually to balance the workload.
+* **Database in-the-loop:** run in-memory for quick, ad-hoc workloads. Otherwise,
+  include a database for persistence, recovery when restarting, and search.
+
+
+Documentation
+-------------
+
+Documentation is available at `hypershell.readthedocs.io <https://hypershell.readthedocs.io>`_.
+For basic usage information on the command line use: ``hs --help``. For a more
+comprehensive usage guide on the command line you can view the manual page with 
+``man hs``.
+
+
+Contributions
+-------------
+
+Contributions are welcome. If you find bugs or have questions, open an *Issue* here.
+We've added a Code of Conduct recently, adapted from the
+`Contributor Covenant <https://www.contributor-covenant.org/>`_, version 2.0.
+
+
+Citation
+--------
+
+If *HyperShell* has helped in your research please consider citing us.
+
+.. code-block:: bibtex
+
+    @inproceedings{lentner_2022,
+        author = {Lentner, Geoffrey and Gorenstein, Lev},
+        title = {HyperShell v2: Distributed Task Execution for HPC},
+        year = {2022},
+        isbn = {9781450391610},
+        publisher = {Association for Computing Machinery},
+        url = {https://doi.org/10.1145/3491418.3535138},
+        doi = {10.1145/3491418.3535138},
+        booktitle = {Practice and Experience in Advanced Research Computing},
+        articleno = {80},
+        numpages = {3},
+        series = {PEARC '22}
+    }

hypershell-2.6.4/pyproject.toml

@@ -0,0 +1,80 @@
+[tool.poetry]
+name = "hypershell"
+version = "2.6.4"
+description = "A cross-platform, high-throughput computing utility for processing shell commands over a distributed, asynchronous queue."
+readme = "README.rst"
+license = "Apache-2.0"
+homepage = "https://hypershell.org"
+documentation = "https://hypershell.readthedocs.io"
+repository = "https://github.com/hypershell/hypershell"
+authors = [
+    "Geoffrey Lentner <glentner@purdue.edu>"
+]
+keywords = [
+    "distributed-computing",
+    "command-line-tool",
+    "shell-scripting",
+    "high-performance-computing",
+    "high-throughput-computing",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Topic :: Utilities",
+    "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",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "License :: OSI Approved :: Apache Software License",
+]
+packages = [{include = "hypershell", from = "src"}]
+
+[tool.poetry.scripts]
+hyper-shell = "hypershell:main"  # NOTE: do not remove this
+hs = "hypershell:main"
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+cmdkit = {version = "^2.7.7", extras = ["toml"]}
+pyyaml = "^6.0.1"  # Allow 6.0.1 for EPEL9 compatibility (2025-01-02)
+tomlkit = "^0.13.2"
+sqlalchemy = "^2.0.29"
+rich = "^13.7.1"
+paramiko = "^3.4.0"
+psycopg2 = {version = "^2.9.9", optional = true}
+
+[tool.poetry.extras]
+postgres = ["psycopg2"]
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^7.2.6"
+sphinx-sitemap = "^2.5.1"
+sphinx-autobuild = "^2024.2.4"
+sphinx-copybutton = "^0.5.2"
+sphinxext-opengraph = "^0.9.1"
+sphinxcontrib-details-directive = "^0.1.0"
+sphinx-toolbox = "^3.5.0"
+sphinx-inline-tabs = "^2023.4.21"
+enum-tools = {extras = ["sphinx"], version = "^0.12.0"}
+furo = "^2024.1.29"
+
+[tool.poetry.group.dev.dependencies]
+psycopg2 = "^2.9.9"
+pytest = "^8.1.1"
+hypothesis = "^6.100.0"
+sphinx-autobuild = "^2024.2.4"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = ["--strict-markers", ]
+markers = [
+    "unit: Unit tests are short, interface driven tests on discrete components.",
+    "integration: Integration tests are often longer and deal with the interaction between systems.",
+    "parameterize: Place holder for parameterized tests (not a real type).",
+]

hypershell-2.6.4/src/hypershell/__init__.py

@@ -0,0 +1,115 @@
+# SPDX-FileCopyrightText: 2025 Geoffrey Lentner
+# SPDX-License-Identifier: Apache-2.0
+
+"""Initialization and entry-point for console application."""
+
+
+# standard libs
+import sys
+from importlib.metadata import version as get_version
+from platform import python_version
+
+# external libs
+from cmdkit.app import Application, ApplicationGroup
+from cmdkit.cli import Interface
+
+# internal libs
+from hypershell.core.logging import Logger, initialize_logging
+from hypershell.core.signal import register_handlers
+from hypershell.submit import SubmitApp
+from hypershell.server import ServerApp
+from hypershell.client import ClientApp
+from hypershell.cluster import ClusterApp
+from hypershell.task import TaskGroupApp
+from hypershell.config import ConfigApp
+from hypershell.data import InitDBApp
+
+# public interface
+__all__ = ['HyperShellApp', 'main', '__version__']
+
+# project metadata
+__version__     = get_version('hypershell')
+__website__     = 'https://github.com/glentner/hypershell'
+__description__ = 'Process shell commands over a distributed, asynchronous queue.'
+__citation__    = """\
+@inproceedings{lentner_2022,
+    author = {Lentner, Geoffrey and Gorenstein, Lev},
+    title = {HyperShell v2: Distributed Task Execution for HPC},
+    year = {2022},
+    isbn = {9781450391610},
+    publisher = {Association for Computing Machinery},
+    url = {https://doi.org/10.1145/3491418.3535138},
+    doi = {10.1145/3491418.3535138},
+    booktitle = {Practice and Experience in Advanced Research Computing},
+    articleno = {80},
+    numpages = {3},
+    series = {PEARC '22}
+}\
+"""
+
+# initialize logger
+log = Logger.with_name('hypershell')
+
+
+# inject logger setup into command-line framework
+Application.log_critical = log.critical
+Application.log_exception = log.exception
+
+
+APP_NAME = 'hs'
+APP_USAGE = f"""\
+Usage:
+  {APP_NAME} [-h] [-v] <command> [<args>...]
+  {__description__}\
+"""
+
+APP_HELP = f"""\
+{APP_USAGE}
+
+Commands:
+  config                 {ConfigApp.__doc__}
+  submit                 {SubmitApp.__doc__}
+  server                 {ServerApp.__doc__}
+  client                 {ClientApp.__doc__}
+  cluster                {ClusterApp.__doc__} (recommended)
+  task                   {TaskGroupApp.__doc__}
+  initdb                 {InitDBApp.__doc__}
+
+Options:
+  -h, --help             Show this message and exit.
+  -v, --version          Show the version and exit.
+      --citation         Show citation info and exit.
+
+Issue tracking at:
+{__website__}
+
+If this software has helped in your research please consider
+citing us (see --citation).\
+"""
+
+
+class HyperShellApp(ApplicationGroup):
+    """Top-level application class for console application."""
+
+    interface = Interface(APP_NAME, APP_USAGE, APP_HELP)
+    interface.add_argument('-v', '--version', action='version',
+                           version=f'HyperShell v{__version__} (Python {python_version()})')
+    interface.add_argument('--citation', action='version', version=__citation__)
+    interface.add_argument('command')
+
+    commands = {
+        'submit': SubmitApp,
+        'server': ServerApp,
+        'client': ClientApp,
+        'cluster': ClusterApp,
+        'task': TaskGroupApp,
+        'config': ConfigApp,
+        'initdb': InitDBApp,
+    }
+
+
+def main() -> int:
+    """Entry-point for console application."""
+    initialize_logging()
+    register_handlers()
+    return HyperShellApp.main(sys.argv[1:])