Skip to content

SebRut/pygrocy

develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

pygrocy

Development Build Status PyPI Python Version Grocy Version Coverage Status CodeFactor pre-commit 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.8/9/10 to run the tests. Navigate to the root dir of pygrocy and execute tox to run the tests.