{ "info": { "author": "Carl J. Nobile", "author_email": "carl.nobile@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Home Automation", "Topic :: System :: Hardware :: Hardware Drivers" ], "description": "# Pololu Motor Control API\n\n## Installation\n\nIt is often useful to install python's virtual environments on your system. \nIf using a Raspberry Pi, Beagle Bone, or any other Linux based credit card\nsized computer a virtual environment, can be useful, but is not necessary. On \na larger computer it can help keep different project's packages separate from \neach other.\n\n### Installing a Virtual Environment\n\nIf you choose to use virtual environments for your working environment the \nfollowing steps will install it for you. The docs are at: \n[virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/).\n\n * This will install the setuptools package needed to get `easy_install`.\n * `$ sudo apt-get install python-setuptools`\n * Then use `easy_install` to install `pip`.\n * `$ sudo easy_install pip`\n * Then use `pip` to install the virtual environment.\n * `$ sudo pip install virtualenvwrapper`\n * Add the next two lines, using your favorite text editor, to the end of the\n `.bashrc` file in your home directory. \n * ```# Setup the Python virtual environment.\n source /usr/local/bin/virtualenvwrapper.sh```\n * Lastly resource the `.bashrc` file in your home directory.\n * `$ source ~/.bashrc`\n\n#### Virtual Environment Hints\n\nThere are many commands that can be used with a virtual environment, for a \nfull list see the link above. All commands below assume the virtual \nenvironment will be named `pololu`.\n\n * To create a new environment type the below command outside of any virtual \n environments you may already have.\n * `$ mkvirtualenv pololu`\n * To enter a virtual environment.\n * `$ workon pololu\n * To exit a virtual environment.\n * `$ deactivate`\n * To completely remove a virtual environment.\n * `$ rmvirtualenv pololu`\n\n### Installing `pololu-motors` with pip\n\nInstalling via `pip` is probably the simplest, but may not work on all \nplatforms. If using a virtual environment be sure you are in the virtual \nenvironment before running the below command. Documentation for pip can be\nfound at: [pip](https://pip.pypa.io/en/latest/).\n\n * `$ pip install pololu-motors`\n\nor directly from the git repository\n\n * Check the version number at the end of the URL, it may have changed.\n * `$ pip install git+https://github.com/cnobile2012/pololu-motors/t-v0.2.1`\n\nThat's it, there is no more to do. The package will also install HTML API docs \nin `/share/doc/pololu_motors/index.html`. Where `` can be \n`/usr`, `/usr/local`, or `~/.virtualenvs/pololu`.\n\n### Installing `pololu-motors` with setup.py\n\nInstalling this way is best if you get the code from a compressed file like a \n`.zip` or `.tar.gz`. This also would work from a clone of the git repository \nat: [pololu-motors](https://github.com/cnobile2012/pololu-motors).\n\n * Search on [PyPi](https://pypi.python.org/) for `pololu-motors` then \n download the file.\n\nor\n\n * Clone the GitHub repository with \n * `$ git clone https://github.com/cnobile2012/pololu-motors.git`\n\nAfter you have the package and expanded it in your work area, you may want to \ninstall it. Installing the package is not necessary if you just want to test \nit out, you can do that directly from the the git clone or the directory \ncreated by the downloaded tarball.\n\n * This will install `pololu-motors` globally.\n * `$ sudo python setup.py install`\n\n## Building the Documentation\n\nThe API docs are generated with [epydoc](http://epydoc.sourceforge.net/). If \nyou want to build the docs yourself there are a few packages that need to be \ninstalled globally on your machine.\n\n * Install the necessary packages.\n * `$ sudo apt-get install python-epydoc epydoc-doc graphviz`\n * Build the docs.\n * `$ make api-docs`\n\n## Running unit tests.\n\nAny good package should have unit tests. These tests give the developer a \nbaseline of how the code should perform. To run the tests you will need a\n[Qik 2s9v1](https://www.pololu.com/product/1110), \n[USB to serial adapter](https://www.pololu.com/product/1308), \n[USB Cable A to Micro-B](https://www.pololu.com/product/1938), \nbreadboard and some jumper leads to connect it all together.\n\nAfter all these items are installed properly you can run the tests. You can \nalso connect a motor to M0. M1 is not tested at this time since most of the \ncode is tested with M0.\n\nThere are two ways to run the unit tests, with the `Makefile` directly or \nwith `tox`.\n\n### Using the `Makefile`\n\n * `$ make tests`\n\n### Using `tox`\n\nFirst you will need to install the tox subsystem then you will be able to run \nthe tests.\n\n * This command will install `tox` in a Python 3.x directory on your system, \n but this will not matter since it is run independently from your \n `pololu-motor` install.\n * `$ sudo pip install tox`\n * Now run `tox`. It will run all the tests.\n * `$ tox`\n\n## Build Instructions\n\n * The package is built with the `make dist` target in the `Makefile`.\n * The version number of the package is ..` and is only\n changed in the `include.mk` file. You will not find the version defined \n anywhere else.\n\n\n--------------------------------------------------------------------\nIf you have any issue please contact me at: carl.nobile at gmail.com", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/cnobile2012/pololu-motors/tarball/t-v0.2.2", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/cnobile2012/pololu-motors", "keywords": "pololu motor API", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "pololu-motors", "package_url": "https://pypi.org/project/pololu-motors/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pololu-motors/", "project_urls": { "Download": "https://github.com/cnobile2012/pololu-motors/tarball/t-v0.2.2", "Homepage": "https://github.com/cnobile2012/pololu-motors" }, "release_url": "https://pypi.org/project/pololu-motors/0.2.2/", "requires_dist": null, "requires_python": null, "summary": "Pololu motor driver APIs.", "version": "0.2.2" }, "last_serial": 1442863, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "b689b15c848e03b5c69382c23826c7c0", "sha256": "fc3fdfb566c2708b7aa9d7b19bd70b021006511d10c55a17a5f690e51cb8a18f" }, "downloads": -1, "filename": "pololu-motors-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b689b15c848e03b5c69382c23826c7c0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 173307, "upload_time": "2015-02-21T01:45:06", "url": "https://files.pythonhosted.org/packages/e5/d3/75fd1834e939528421a8be47a10a052dc16a43bb081539bcb29730f9422f/pololu-motors-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "565f5c0f9935e08e9ecd5bca0530a4cd", "sha256": "6cfa6c0e0ab4a518d345a242bf6cd11f224cef505089a3555ebd248e892b1333" }, "downloads": -1, "filename": "pololu-motors-0.1.2.tar.gz", "has_sig": false, "md5_digest": "565f5c0f9935e08e9ecd5bca0530a4cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 173339, "upload_time": "2015-02-21T02:25:21", "url": "https://files.pythonhosted.org/packages/05/22/5f32dfaec8bebbfc2a12dec3f79893ddf70c9f17132d6a621f8eddc98e09/pololu-motors-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "c18f201b148ba91963dcf11f8c0de45a", "sha256": "c71f86c068fca4611a1d4ab1fe50555ed68bd03ed3fab4d08b2d9b7a589fb276" }, "downloads": -1, "filename": "pololu-motors-0.2.0.tar.gz", "has_sig": false, "md5_digest": "c18f201b148ba91963dcf11f8c0de45a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 168246, "upload_time": "2015-02-23T00:42:20", "url": "https://files.pythonhosted.org/packages/67/2d/adfd3368f78eb6e69643c66679eca54e0bb9fd613027d2977e486f4a8fea/pololu-motors-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "6b50c218ac2ec225a7aae8219c8776f3", "sha256": "351584a4b8345abb5d46417e4a493ea6f777136b935f541a4bdd7854533ff13a" }, "downloads": -1, "filename": "pololu-motors-0.2.1.tar.gz", "has_sig": false, "md5_digest": "6b50c218ac2ec225a7aae8219c8776f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 174371, "upload_time": "2015-02-23T01:29:40", "url": "https://files.pythonhosted.org/packages/30/b6/6123bdcf6fcc3df39379d130f4e6ccfac68cd448a273449523848446bb4d/pololu-motors-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "0567d63e913aa89ece9402d040f66b56", "sha256": "68ab8870d8a0093f22cba80421716f858447b71464582f36791b585095b68233" }, "downloads": -1, "filename": "pololu-motors-0.2.2.tar.gz", "has_sig": false, "md5_digest": "0567d63e913aa89ece9402d040f66b56", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 174384, "upload_time": "2015-03-01T04:38:11", "url": "https://files.pythonhosted.org/packages/fd/38/4806eb6922ccdf390388a2d6ddcbd790813f92132fd80f6a6d3cd44dacc3/pololu-motors-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0567d63e913aa89ece9402d040f66b56", "sha256": "68ab8870d8a0093f22cba80421716f858447b71464582f36791b585095b68233" }, "downloads": -1, "filename": "pololu-motors-0.2.2.tar.gz", "has_sig": false, "md5_digest": "0567d63e913aa89ece9402d040f66b56", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 174384, "upload_time": "2015-03-01T04:38:11", "url": "https://files.pythonhosted.org/packages/fd/38/4806eb6922ccdf390388a2d6ddcbd790813f92132fd80f6a6d3cd44dacc3/pololu-motors-0.2.2.tar.gz" } ] }