RunRunner

Name	RunRunner JSON
Version	0.1.8 JSON
	download
home_page	https://github.com/thijssnelleman/RunRunner
Summary	RunRunner is a wrapper library for creating and managing subprocesses and their status, mainly focussed on using Slurm but (in absence) can also work with local jobs.
upload_time	2024-10-28 12:34:21
maintainer	None
docs_url	None
author	Thijs Snelleman
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	pydantic pytest flake8 flake8-quotes pep8-naming flake8-docstrings flake8-annotations
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # RunRunner - A Python handler for managing (Slurm)Jobs

RunRunner is a wrapper library for creating and managing subprocesses and their status', mainly focussed on using Slurm but (in absence) can also work with local jobs.

## Installation

Installation of the latest version is done using Pip:

pip install RunRunner

## Usage

RunRunner works with 'queues', either the local version or Slurm version. To use RunRunner, simply add the bash call you want to be executed to the queue with:

``add_to_queue''

By specifying Runner (an Enum from base.py), RunRunner determines whether to add to the local queue (local.py) or Slurm (Slurm.py). To check what arguments each queue accepts, see the add_to_queue implementations at the top of each respective file. The call to the queue returns a structured object (a LocalRun or SlurmRun) containing the data regarding the subprocess. A run consists of one or more jobs which will contains the actual subprocess call. To start a run after creation, one can simply .submit the run and .wait for it to be done. To verify if everything went correctly, a .Status is supplied which uses .Status enum from base.py.


## Credits

Developers:
* Thijs Snelleman
* Jeroen Rook
* Koen van der Blom (Inactive)
* Jeremy Gobeil (Original developer, inactive)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/thijssnelleman/RunRunner",
    "name": "RunRunner",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Thijs Snelleman",
    "author_email": "fkt_sparkle@aim.rwth-aachen.de",
    "download_url": "https://files.pythonhosted.org/packages/ea/6e/c993c11a50a57e38ec60ddd8f51a411249fbf3c5370460bb1fa1a3e84a2e/RunRunner-0.1.8.tar.gz",
    "platform": null,
    "description": "# RunRunner - A Python handler for managing (Slurm)Jobs\n\nRunRunner is a wrapper library for creating and managing subprocesses and their status', mainly focussed on using Slurm but (in absence) can also work with local jobs.\n\n## Installation\n\nInstallation of the latest version is done using Pip:\n\npip install RunRunner\n\n## Usage\n\nRunRunner works with 'queues', either the local version or Slurm version. To use RunRunner, simply add the bash call you want to be executed to the queue with:\n\n``add_to_queue''\n\nBy specifying Runner (an Enum from base.py), RunRunner determines whether to add to the local queue (local.py) or Slurm (Slurm.py). To check what arguments each queue accepts, see the add_to_queue implementations at the top of each respective file. The call to the queue returns a structured object (a LocalRun or SlurmRun) containing the data regarding the subprocess. A run consists of one or more jobs which will contains the actual subprocess call. To start a run after creation, one can simply .submit the run and .wait for it to be done. To verify if everything went correctly, a .Status is supplied which uses .Status enum from base.py.\n\n\n## Credits\n\nDevelopers:\n* Thijs Snelleman\n* Jeroen Rook\n* Koen van der Blom (Inactive)\n* Jeremy Gobeil (Original developer, inactive)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "RunRunner is a wrapper library for creating and managing subprocesses and their status, mainly focussed on using Slurm but (in absence) can also work with local jobs.",
    "version": "0.1.8",
    "project_urls": {
        "Homepage": "https://github.com/thijssnelleman/RunRunner"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea6ec993c11a50a57e38ec60ddd8f51a411249fbf3c5370460bb1fa1a3e84a2e",
                "md5": "8e26da088345db8e7e26b8d2b4e90f21",
                "sha256": "1f33b8ca9e6e2de6bc663e30fbdac8fd0443e26829c9d0b6d8a60897c74183e3"
            },
            "downloads": -1,
            "filename": "RunRunner-0.1.8.tar.gz",
            "has_sig": false,
            "md5_digest": "8e26da088345db8e7e26b8d2b4e90f21",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16027,
            "upload_time": "2024-10-28T12:34:21",
            "upload_time_iso_8601": "2024-10-28T12:34:21.534464Z",
            "url": "https://files.pythonhosted.org/packages/ea/6e/c993c11a50a57e38ec60ddd8f51a411249fbf3c5370460bb1fa1a3e84a2e/RunRunner-0.1.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-28 12:34:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "thijssnelleman",
    "github_project": "RunRunner",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "pydantic",
            "specs": [
                [
                    "<",
                    "2.0a"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "flake8",
            "specs": []
        },
        {
            "name": "flake8-quotes",
            "specs": []
        },
        {
            "name": "pep8-naming",
            "specs": []
        },
        {
            "name": "flake8-docstrings",
            "specs": []
        },
        {
            "name": "flake8-annotations",
            "specs": []
        }
    ],
    "lcname": "runrunner"
}