jonvmey / pygrocy

pygrocy

Documentation

Installation

pip install pygrocy

Usage

Import the package:

from pygrocy import Grocy

Obtain a grocy instance:

grocy = Grocy("https://example.com", "GROCY_API_KEY")

or

grocy = Grocy("https://example.com", "GROCY_API_KEY", port = 9192, verify_ssl = True)

Get current stock:

for entry in grocy.stock():
    print("{} in stock for product id {}".format(entry.available_amount, entry.id))

Support

If you need help using pygrocy check the discussions section. Feel free to create an issue for feature requests, bugs and errors in the library.

Development testing

You need tox and Python 3.6/8/9 to run the tests. Navigate to the root dir of pygrocy and execute tox to run the tests.