- User Guide and documentation:
- Clone source:
git clone git://github.com/fauskanger/mypolr.git
pip install mypolr[ PyPI.org | Legacy ]
To use mypolr, you need a valid API key to a server with the Polr Project installed.
You can obtain the API key by logging in to your Polr site and navigate to <polr project root>/admin#developer.
Disclaimer: This package, mypolr, is not affiliated with the Polr Project.
There is only one requirement:
requests, an awesome HTTP library. (Documentation).
When installing with pip or conda this will be installed automatically (if not already installed).
Tested on Python 2.7, 3.4+, but should also work with version 3.3.
- With pip:
pip install mypolr
- With conda:
conda install -c fauskanger mypolr
:raises:docstring fields to methods/docs.
- Implement the
/data/link-endpoint if necessary.
This project is licensed under the MIT Licence. (See link for details.)
This project has served several purposes:
- Have a tool to easily utilize the Polr Project API from Python.
- Be an exercise in packaging and distributing Python modules (with pip and conda).
- Be an exercise in reStructuredText, Sphinx documentation, and ReadTheDocs.
- Be an exercise in testing Python along best practices and conventions.