{ "info": { "author": "Bailey Hwa", "author_email": "hwab@janelia.hhmi.org", "bugtrack_url": null, "classifiers": [], "description": "|Code Health|\n\n--------------\n\nMouse Record\n==============\n\n**A cheap, modular, behavior recording program**\n\n.. figure:: Mouserecord_logo.jpg\n :alt: Mouserecord\\_logo.jpg\n\n\nPurpose\n=======\n\nThe program's is designed to record rodent behavior at specific\nintervals of time, based on the initiation of a trigger event (e.g., the\npress of a lever).\n\nInstallation\n============\n\nInstallation requires setuptools_; install\nusing the following command (may require ``sudo``):\n\n::\n\n python setup.py install\n\nTesting\n=======\n\nTest the program using the following command:\n\n::\n\n python setup.py test\n\nDocumentation\n=============\n\nDocumentation can be built from source on any platform easily. Just run the\nfollowing command.\n\n::\n\n python setup.py build_sphinx\n\nThis will generate HTML documentation, which can be open using this file\n``build/sphinx/html/index.html`` in the current directory.\n\nFor more build options, simply run the following command.\n\n::\n\n python setup.py build_sphinx --help\n\nOther build targets can be specified using the ``-b`` or ``--builder`` option.\nBeyond the standard options that Sphinx provides, we add the `pdf` option.\n\nCleaning\n========\n\nTo clean up the directory after building, one can use the ``clean`` option.\nThis will eliminate all intermediates build products. The syntax is shown\nbelow.\n\n::\n\n python setup.py clean\n\nIf this is not sufficient, and one wishes to eliminate the final products this\ncan be done with the flag ``-a`` or ``--all``. This adjustment to the syntax is\nshown below.\n\n::\n\n python setup.py clean --all\n\nUsage\n=====\n\nPicture Usage\n-------------\n\nExecution of the program consists of the program name and a single\nargument, the directory in which the picture is to be saved into.\nIf a directory is not specified, the current directory will be\nassumed.\n\n::\n\n mouse-picture ~/Destkop\n\nPreview Usage\n-------------\n\nExecution of the program consists of the program name and a single\nargument: the time desired length of the camera preview (in seconds).\nIf the time is not specified, this will default to 15 seconds.\nAdditionally, the user can exit at any time by entering ``Ctrl + c``\n\n::\n\n mouse-preview 60\n\nRecord Usage\n--------------\n\nExecution of the program consists of the program name and respectve\narguments: time to record before trigger event (in seconds), time to\nrecord after (in seconds), and directory of the file to be saved into.\nIf a directory is not specified, the current directory will be\nassumed. An example is shown below:\n\n::\n\n sudo mouse-record 2 2 /home/pi/Desktop\n\nAlso, as mentioned before, the program will end when a ``Ctrl + c`` is\nentered into the terminal.\n\n.. _setuptools: https://pypi.python.org/pypi/setuptools\n\n.. |Code Health| image:: https://landscape.io/github/DudLab/mouse_record/master/landscape.svg?style=flat\n :target: https://landscape.io/github/DudLab/mouse_record/master\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/DudLab/mouse_record", "keywords": null, "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "mouse_record", "package_url": "https://pypi.org/project/mouse_record/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mouse_record/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/DudLab/mouse_record" }, "release_url": "https://pypi.org/project/mouse_record/0.0.6/", "requires_dist": null, "requires_python": null, "summary": "An Event Triggered Recorder", "version": "0.0.6" }, "last_serial": 1843727, "releases": { "0.0.5": [ { "comment_text": "", "digests": { "md5": "c8d291743d5b54061aeaee4baafa8f98", "sha256": "613acfa8d782b0ffdbd569d42fa53587f57eb1c0966d7f8f55b7a038be09547a" }, "downloads": -1, "filename": "mouse_record-0.0.5.tar.gz", "has_sig": false, "md5_digest": "c8d291743d5b54061aeaee4baafa8f98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21228, "upload_time": "2015-11-02T01:56:31", "url": "https://files.pythonhosted.org/packages/b9/a1/de5b85761d04c2139ef944c919788486763724b43de33f460c32e5cbae3a/mouse_record-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "fb07518539ce95069687c730c78d694e", "sha256": "bd4da5b6df266db9d22492cb55e7511e007528c2c26a6aad6e8738595ed6385d" }, "downloads": -1, "filename": "mouse_record-0.0.6.tar.gz", "has_sig": false, "md5_digest": "fb07518539ce95069687c730c78d694e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21236, "upload_time": "2015-11-02T01:56:49", "url": "https://files.pythonhosted.org/packages/d1/86/444271c7f940b99b389cfb46e87c2717614b819f536bf69f852b2963e0e5/mouse_record-0.0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fb07518539ce95069687c730c78d694e", "sha256": "bd4da5b6df266db9d22492cb55e7511e007528c2c26a6aad6e8738595ed6385d" }, "downloads": -1, "filename": "mouse_record-0.0.6.tar.gz", "has_sig": false, "md5_digest": "fb07518539ce95069687c730c78d694e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21236, "upload_time": "2015-11-02T01:56:49", "url": "https://files.pythonhosted.org/packages/d1/86/444271c7f940b99b389cfb46e87c2717614b819f536bf69f852b2963e0e5/mouse_record-0.0.6.tar.gz" } ] }