/LCBOAPI

Python wrapper for the unofficial LCBO API

Primary LanguagePythonMIT LicenseMIT

LCBOAPI - v0.2.1

Python 3 wrapper for the unofficial LCBO API

Full API documentation for LCBO API can be found at: [https://lcboapi.com/docs]

Installation

Via PyPI:

$ pip install lcboapi

Via Github:

$ git clone https://github.com/shamrt/LCBOAPI.git
$ cd LCBOAPI
$ python setup.py install

Usage

Obtain an access key from LCBO API.

Initialize API wrapper:

from lcboapi import LCBOAPI

api = LCBOAPI('your_API_access_key')

Get data for store #614:

print api.stores(614)

Testing

First setup your virtual environment:

$ virtualenv env
$ . env/bin/activate
$ pip install -r requirements.txt

Then set an environment variable for your API access key:

$ export LCBOAPI_ACCESS_KEY='your_API_access_key'

Finally, run tests:

$ py.test

Versioning and Publishing

Requirements:

Run:

$ . env/bin/activate
$ pytest tests/
$ bumpversion [patch/minor/major]
$ python setup.py sdist bdist_wheel
$ python -m twine upload dist/*