egtaonlineapi


Nameegtaonlineapi JSON
Version 0.8.0 PyPI version JSON
download
home_pagehttps://github.com/egtaonline/egtaonline-api.git
SummaryVarious APIs for egtaonline
upload_time2018-04-16 14:20:30
maintainer
docs_urlNone
authorStrategic Reasoning Group
requires_python
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            EGTAOnline Api
==============

[![Build](https://img.shields.io/travis/egtaonline/egtaonline-api.svg?style=flat-square)](https://travis-ci.org/egtaonline/egtaonline-api)
[![Coverage](https://img.shields.io/coveralls/egtaonline/egtaonline-api.svg?style=flat-square)](https://coveralls.io/github/egtaonline/egtaonline-api)

Command line and python access to egtaonline.


Install
-------

```
pip install egtaonlineapi
```


Usage
-----

- The command line entry point is `eo`.
  `eo --help` will list all the options available.
- The python entry point is `egtaonline.api`.
  This has slightly more functionality than the command line api.
- There is also a mock server at `egtaonline.mockserver` that handles all requests without actually modifying egta.


Cookbook
--------

These are useful scripts that illustrate what can be done with the api.

- Monitor a scheduler and report when it's done:

  ```
  while ! eo sched <sched-id> -r | jq -e '.scheduling_requirements | map(.current_count >= .requirement) | all' > /dev/null; do sleep <sleep-interval>; done; <notify-script>
  ```

  This will poll `<sched-id>` every `<sleep-interval>` seconds and run `<notify-script>` when the scheduler is done.



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2018-04-16 14:20:30", 
    "author": "Strategic Reasoning Group", 
    "home_page": "https://github.com/egtaonline/egtaonline-api.git", 
    "github_user": "egtaonline", 
    "download_url": "", 
    "platform": "", 
    "version": "0.8.0", 
    "cheesecake_documentation_id": null, 
    "description": "EGTAOnline Api\n==============\n\n[![Build](https://img.shields.io/travis/egtaonline/egtaonline-api.svg?style=flat-square)](https://travis-ci.org/egtaonline/egtaonline-api)\n[![Coverage](https://img.shields.io/coveralls/egtaonline/egtaonline-api.svg?style=flat-square)](https://coveralls.io/github/egtaonline/egtaonline-api)\n\nCommand line and python access to egtaonline.\n\n\nInstall\n-------\n\n```\npip install egtaonlineapi\n```\n\n\nUsage\n-----\n\n- The command line entry point is `eo`.\n  `eo --help` will list all the options available.\n- The python entry point is `egtaonline.api`.\n  This has slightly more functionality than the command line api.\n- There is also a mock server at `egtaonline.mockserver` that handles all requests without actually modifying egta.\n\n\nCookbook\n--------\n\nThese are useful scripts that illustrate what can be done with the api.\n\n- Monitor a scheduler and report when it's done:\n\n  ```\n  while ! eo sched <sched-id> -r | jq -e '.scheduling_requirements | map(.current_count >= .requirement) | all' > /dev/null; do sleep <sleep-interval>; done; <notify-script>\n  ```\n\n  This will poll `<sched-id>` every `<sleep-interval>` seconds and run `<notify-script>` when the scheduler is done.\n\n\n", 
    "lcname": "egtaonlineapi", 
    "bugtrack_url": null, 
    "github": true, 
    "name": "egtaonlineapi", 
    "license": "Apache 2.0", 
    "github_project": "egtaonline-api.git", 
    "summary": "Various APIs for egtaonline", 
    "split_keywords": [], 
    "author_email": "strategic.reasoning.group@umich.edu", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-04-16T14:20:30", 
            "comment_text": "", 
            "python_version": "py3", 
            "url": "https://pypi.python.org/packages/ef/37/4188875d2c4a0fe86fd634a8b49c6bb1d4efec73217e427ef97cc07b62d4/egtaonlineapi-0.8.0-py3-none-any.whl", 
            "md5_digest": "a43f42cf7019816184ab7d6f73eec761", 
            "downloads": 0, 
            "filename": "egtaonlineapi-0.8.0-py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "ef/37/4188875d2c4a0fe86fd634a8b49c6bb1d4efec73217e427ef97cc07b62d4/egtaonlineapi-0.8.0-py3-none-any.whl", 
            "digests": {
                "sha256": "e208641e00702625cc387666f2a1f6543cc300b520dfaf0a0202ad8a85d6ec1b", 
                "md5": "a43f42cf7019816184ab7d6f73eec761"
            }, 
            "sha256_digest": "e208641e00702625cc387666f2a1f6543cc300b520dfaf0a0202ad8a85d6ec1b", 
            "size": 33629
        }
    ], 
    "error": "Could not fetch GitHub repository", 
    "_id": null, 
    "cheesecake_installability_id": null
}