Skip to main content

No project description provided

Project description

pygrocydm

Build Status CodeFactor Coverage Status PyPI Automated Release Notes by gren DeepSource FOSSA Status

Installation

pip install pygrocydm

Documentation

Check Grocy API

https://blueblueblob.github.io/pygrocydm/

Usage

Import the package:

from pygrocydm import GrocyAPI

Obtain a grocy data manager instance:

gapi = GrocyAPI("https://example.com", "GROCY_API_KEY")

or

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

Product list (Generic entities API)

products = gapi.generic_entities().products()
products_list = products.list
for product in products_list:
    print(vars(product))
    if product.name == "Cookies":
        product.delete()
    if product.name == "Chocolate":
        data = {}
        data['name'] = "Choco"
        product.edit(data)
else:
    new_product = {}
    new_product['name'] = 'Cookies'
    new_product['location_id'] = 1
    new_product['qu_id_purchase'] = 1
    new_product['qu_id_stock'] = 1
    new_product['qu_factor_purchase_to_stock'] = 1
    new_product_id = products.add(new_product)

Recipes API :

recipes_api = gapi.recipes()
for recipe in recipes_api.fullfilment_list:
    if recipe.recipe_id == 5:
        recipe.add_not_fulfilled_products_to_shoppinglist()
    else:
        recipe.consume()
recipes_api.refresh()

Tasks API :

tasks_api = gapi.tasks()
for task in tasks_api.tasks_list:
    if task.id == 5:
        task.complete()
        task.undo()
tasks_api.refresh()

System API :

system_api = gapi.system()
last_db_change = system_api.db_changed_time()

License

FOSSA Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygrocydm-0.8.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygrocydm-0.8.0-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file pygrocydm-0.8.0.tar.gz.

File metadata

  • Download URL: pygrocydm-0.8.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for pygrocydm-0.8.0.tar.gz
Algorithm Hash digest
SHA256 0edeb5b341a3e7e3db3ab437ef901e18cf4e3a72dabcc4ede81e74b51c8b1314
MD5 29f540f8d98480cae3088219a040a02a
BLAKE2b-256 c7ef8e9cb836bdbc7ce39456e5ef9b44010ffb978cd101094f5cca955ea788d3

See more details on using hashes here.

File details

Details for the file pygrocydm-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: pygrocydm-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for pygrocydm-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66cbabd2ec54ae0a64b11da8f6d67f94f7c5132aaa78317eb4ba80aecc66af4a
MD5 35ba59abe6a6abbb911d497d1ab3f8fd
BLAKE2b-256 078c0908112ffeda672eccd91cdeede398d255d129d70458a5ab0cd012a13595

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page