{
    "info": {
        "author": "Jason Yosinski",
        "author_email": "git_results_manager.jyo@0sg.net",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "GitResultsManager\n=====================\n\nNote: GitResultsManager does not profess to be remotely operable on\nany operating system besides Linux and Mac. Evidence of success on\nother OSs is appreciated.\n\n\n\nInstalling\n---------------------\n\n### One line global install:\n\n    git clone https://github.com/yosinski/GitResultsManager.git && \\\n    cd GitResultsManager && \\\n    sudo python setup.py install && \\\n    sudo cp resman resman-td git-recreate /usr/local/bin/\n\nReplace `/usr/local/bin` with another location on your path, if desired. If installing the Python packages in your home directory (perhaps using virtualenv), you should omit the first `sudo`, and if installing scripts in your home directory, skip the second.\n\n\n\nUsage\n---------------------\n\nGitResultsManager may be used in two ways:\n\n1. **(recommended)** Using the `resman` wrapper script to run programs in any language, or\n2. From within Python as a Python module.\n\n(1) is more general, while (2) offers more control. The following examples are available in the `examples` directory.\n\n### Example of using `resman` wrapper script to run a C program:\n\nFirst, we'll compile the `demo-c` program (from the examples directory) and run it without `resman`:\n\n    g++ -o demo-c demo-c.cc   # compile program first if necessary\n    ./demo-c\n\nOutput:\n\n    Environment variable GIT_RESULTS_MANAGER_DIR is undefined. To demonstrate logging, run this instead as\n        resman junk ./demo-c\n    This line is logged\n    This line is logged (stderr)\n    This line is logged\n    This line is logged (stderr)\n    This line is logged\n    This line is logged (stderr)\n\nNotice that it complains it cannot find the GIT_RESULTS_MANAGER_DIR\nenvironment variable. This is how the program knows it is not being\nrun from within `resman`. Now, try using `resman` to run it:\n\n    resman -r run-name ./demo-c\n\nOutput:\n\n    WARNING: GitResultsManager running in GIT_DISABLED mode: no git information saved! (Is /Users/jason/temp/examples in a git repo?)\n      Logging directory: results/121030_183101_run-name\n            Command run: ./demo-c\n               Hostname: lapaz\n      Working directory: /Users/jason/temp/examples\n    The current GIT_RESULTS_MANAGER_DIR is: results/121030_183101_run-name\n    This line is logged\n    This line is logged\n    This line is logged\n    This line is logged (stderr)\n    This line is logged (stderr)\n    This line is logged (stderr)\n           Wall time:  0.024\n      Processor time:  0.012\n\nNotice how `resman` adds a few lines of information to the beginning and ending of the output? Looking at each line in order:\n\n    WARNING: GitResultsManager running in GIT_DISABLED mode: no git information saved! (Is /Users/jason/temp/examples in a git repo?)\n\nWarning because we aren't running from within a git repository, removing most of the usefulness of GitResultsManager.\n\n      Logging directory: results/121030_183101_run-name\n\nThe directory that was created for this run, in the format `<datestamp>_<timestamp>_<name of run>`\n\n            Command run: ./demo-c\n\nWhich command you actually ran.\n\n               Hostname: lapaz\n\nThe host this run was performed on (useful when running on clusters or\nmultiple machines with non-identical configurations)\n\n      Working directory: /Users/jason/temp/examples\n\nThe working directory. Next follows the actual output of the program, and then at the end...\n\n           Wall time:  0.024\n      Processor time:  0.012\n\n`resman` notes how long the program took to execute in wall time and processor time.\n\n\n\n### Simple code change to use `resman` wrapper script in Python:\n\nImport the `os` module:\n\n    import os\n\nCheck if we're running from within `resman`. If so, use the directory `resman` provides, else save output to the current directory:\n\n    try:\n        savedir = os.environ['GIT_RESULTS_MANAGER_DIR']\n    except KeyError:\n        savedir = '.'\n\n    # later in code, when saving plots / etc:\n\n    savefig(os.path.join(savedir, 'myplot.png'))\n\n\n\n### Example of using the `GitResultsManager` class within Python.\n\nSee `examples/demo-GRM-module.py`.\n\n\n\nDevelopment task list\n----------------------\n\n### To do\n\n1. Add settings override via `~/.config/gitresultsmanager_config.py` or similar\n1. Documentation\n\nWant to help? Pull requests are welcome!\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/yosinski/GitResultsManager",
        "keywords": "",
        "license": "LICENSE.txt",
        "maintainer": "",
        "maintainer_email": "",
        "name": "GitResultsManager",
        "package_url": "https://pypi.org/project/GitResultsManager/",
        "platform": "",
        "project_url": "https://pypi.org/project/GitResultsManager/",
        "project_urls": {
            "Homepage": "https://github.com/yosinski/GitResultsManager"
        },
        "release_url": "https://pypi.org/project/GitResultsManager/0.4.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "The GitResultsManager Python module and scripts (resman) for keeping track of research results using Git.",
        "version": "0.4.1"
    },
    "last_serial": 5117034,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6e3d6fb728db50788af68d4e4f3efc7c",
                    "sha256": "f8c54dd4e0c55b34c1a20cf9fe781e93e1f20061d7570843dad074d8f75e0d63"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6e3d6fb728db50788af68d4e4f3efc7c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10750,
                "upload_time": "2013-09-20T02:34:08",
                "url": "https://files.pythonhosted.org/packages/f5/1a/061c5038f631c3f91f7904ab9e9bf02f393955ea761ce703fe45377eafbe/GitResultsManager-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2a59c2d6c27189981dedf50e3c139eb2",
                    "sha256": "14bfaef7eede6a3ab2c23f751ca9d383eb556d9abb7157629f37fc6855af0816"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "2a59c2d6c27189981dedf50e3c139eb2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11366,
                "upload_time": "2013-09-20T16:33:44",
                "url": "https://files.pythonhosted.org/packages/46/bc/e0b48ae83c63ab5178811051139679a806473ac57d0eb2466d082ebdafb8/GitResultsManager-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ec346d117ad1d66237e1de99f95aaa47",
                    "sha256": "ae4b5aeb67524aafbc7bcfdc7977a90c6e7d2d3087d8b6fbd3b275f88fbb090c"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "ec346d117ad1d66237e1de99f95aaa47",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25118,
                "upload_time": "2017-10-03T02:55:39",
                "url": "https://files.pythonhosted.org/packages/4d/4e/64da294e2935af7bbb66ce80064aaff4076b2be9d55b101d354fb6c45c11/GitResultsManager-0.3.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "23fe67f43a22dbd598c5393ea09086f5",
                    "sha256": "4c5ecbd44eb7099694c5ce6fbb125910886924d059fde55d8111f5c622cec090"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "23fe67f43a22dbd598c5393ea09086f5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25288,
                "upload_time": "2017-10-03T03:48:10",
                "url": "https://files.pythonhosted.org/packages/98/7c/bdbe365a3af96a902c4918ad91205b29a4f18bf5640774a47a5f401b358d/GitResultsManager-0.3.1.tar.gz"
            }
        ],
        "0.3.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "766be38194bb085f042935af832534d6",
                    "sha256": "5a759a8c017356e6c3ed8e55eeb68a6ff7778a16eddeb8999714708e1185bf0f"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.3.2.tar.gz",
                "has_sig": false,
                "md5_digest": "766be38194bb085f042935af832534d6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25358,
                "upload_time": "2017-10-10T23:10:34",
                "url": "https://files.pythonhosted.org/packages/6f/6e/d9c3e3ab9a22405b35d265414d8d43b8d8427daee6132c0fc0ab3a4d7a96/GitResultsManager-0.3.2.tar.gz"
            }
        ],
        "0.3.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5640f3623333d7987b596908943e85fb",
                    "sha256": "4674c502ca2cbf67a5dd1fdfd66c167ccb8f5c7a0c6b45be674b7fdaffdfb827"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.3.3.tar.gz",
                "has_sig": false,
                "md5_digest": "5640f3623333d7987b596908943e85fb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25397,
                "upload_time": "2017-10-19T19:10:53",
                "url": "https://files.pythonhosted.org/packages/4e/8f/efa24e6f02ea4ef5cfd67b7ab014e088b4b5593be3a1038332316bc0621b/GitResultsManager-0.3.3.tar.gz"
            }
        ],
        "0.3.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2dd53172ef4230dba14ff6e5f02650f9",
                    "sha256": "ede8c4613b50d1b826cdf080a45ced99fcca70cc91c601df89c717809ea219ab"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.3.4.tar.gz",
                "has_sig": false,
                "md5_digest": "2dd53172ef4230dba14ff6e5f02650f9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26589,
                "upload_time": "2019-02-07T05:02:04",
                "url": "https://files.pythonhosted.org/packages/1d/b5/588acf515a6fe18dab1deabfd41017c2328e82819a24042bc846e0d30a81/GitResultsManager-0.3.4.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f3394641a346206c60deebb30c1f793a",
                    "sha256": "b8a66e23c5bc0c1f774cc53ced889a21b492a6fb5c6b4d9888fb7414dad051a6"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f3394641a346206c60deebb30c1f793a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26904,
                "upload_time": "2019-02-13T01:55:20",
                "url": "https://files.pythonhosted.org/packages/ca/db/e1a59a6b6a6452e4d9b09eb084f628b1a8190cc30a966289c3f915c87f67/GitResultsManager-0.4.0.tar.gz"
            }
        ],
        "0.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5300ea78e5ef900a815fb752583fe83c",
                    "sha256": "8b04b9878a01948d130be7f6dea5347eb8f3666e8ea88ede868fd7b3463cec4e"
                },
                "downloads": -1,
                "filename": "GitResultsManager-0.4.1.tar.gz",
                "has_sig": false,
                "md5_digest": "5300ea78e5ef900a815fb752583fe83c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26142,
                "upload_time": "2019-04-09T05:52:31",
                "url": "https://files.pythonhosted.org/packages/ce/08/164c1a8b23a0c10a4fe6156e12c2942460f2dbd681cd361d7e2ed6037612/GitResultsManager-0.4.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5300ea78e5ef900a815fb752583fe83c",
                "sha256": "8b04b9878a01948d130be7f6dea5347eb8f3666e8ea88ede868fd7b3463cec4e"
            },
            "downloads": -1,
            "filename": "GitResultsManager-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5300ea78e5ef900a815fb752583fe83c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26142,
            "upload_time": "2019-04-09T05:52:31",
            "url": "https://files.pythonhosted.org/packages/ce/08/164c1a8b23a0c10a4fe6156e12c2942460f2dbd681cd361d7e2ed6037612/GitResultsManager-0.4.1.tar.gz"
        }
    ]
}