**This project is de-facto unmaintained as haven't been using grocy for a while. Feel free to fork and create pygrocy2!**
# pygrocy
[](https://travis-ci.com/SebRut/pygrocy)
[](https://pypi.org/project/pygrocy/)
[](https://coveralls.io/github/SebRut/pygrocy?branch=master)
[](https://www.codefactor.io/repository/github/sebrut/pygrocy)
[](https://github.com/pre-commit/pre-commit)
[Documentation](https://sebrut.github.io/pygrocy/)
## Installation
`pip install pygrocy`
## Usage
Import the package:
```python
from pygrocy import Grocy
```
Obtain a grocy instance:
```python
grocy = Grocy("https://example.com", "GROCY_API_KEY")
```
or
```python
grocy = Grocy("https://example.com", "GROCY_API_KEY", port = 9192, verify_ssl = True)
```
Get current stock:
```python
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](https://github.com/SebRut/pygrocy/issues) 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/sebrut/pygrocy",
"name": "pygrocy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Sebastian Rutofski",
"author_email": "kontakt@sebastian-rutofski.de",
"download_url": "https://files.pythonhosted.org/packages/e0/52/4135165cee7e25b4014fbe09f5126cf348d3be03caac08cdbb41fe68dec7/pygrocy-2.1.0.tar.gz",
"platform": null,
"description": "**This project is de-facto unmaintained as haven't been using grocy for a while. Feel free to fork and create pygrocy2!**\n\n# pygrocy\n[](https://travis-ci.com/SebRut/pygrocy)\n[](https://pypi.org/project/pygrocy/)\n\n\n[](https://coveralls.io/github/SebRut/pygrocy?branch=master)\n[](https://www.codefactor.io/repository/github/sebrut/pygrocy)\n[](https://github.com/pre-commit/pre-commit)\n[Documentation](https://sebrut.github.io/pygrocy/)\n\n## Installation\n\n`pip install pygrocy`\n\n## Usage\nImport the package:\n```python\nfrom pygrocy import Grocy\n```\n\nObtain a grocy instance:\n```python\ngrocy = Grocy(\"https://example.com\", \"GROCY_API_KEY\")\n```\nor\n```python\ngrocy = Grocy(\"https://example.com\", \"GROCY_API_KEY\", port = 9192, verify_ssl = True)\n```\n\nGet current stock:\n```python\nfor entry in grocy.stock():\n print(\"{} in stock for product id {}\".format(entry.available_amount, entry.id))\n```\n\n# Support\n\nIf you need help using pygrocy check the [discussions](https://github.com/SebRut/pygrocy/issues) section. Feel free to create an issue for feature requests, bugs and errors in the library.\n\n## Development testing\nYou 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/sebrut/pygrocy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30ff4f748d585f67817409f2a994307766dbcefbbbe0e772e0cfef16115610a1",
"md5": "543c96ebefdb6f2bb9dad481060d0502",
"sha256": "e5bfd8eb75a73064e2429bfe6dc7f7fe562ee29e83595ae633ff4b9e1cb0551f"
},
"downloads": -1,
"filename": "pygrocy-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "543c96ebefdb6f2bb9dad481060d0502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 32195,
"upload_time": "2024-04-23T12:45:28",
"upload_time_iso_8601": "2024-04-23T12:45:28.040952Z",
"url": "https://files.pythonhosted.org/packages/30/ff/4f748d585f67817409f2a994307766dbcefbbbe0e772e0cfef16115610a1/pygrocy-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0524135165cee7e25b4014fbe09f5126cf348d3be03caac08cdbb41fe68dec7",
"md5": "6b1642e5a73ae1df0ad0cb2917bfd6de",
"sha256": "365b31941f18d8485363f7fa75192cf210ae805c7dbdb28dba555d0d8c15f326"
},
"downloads": -1,
"filename": "pygrocy-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6b1642e5a73ae1df0ad0cb2917bfd6de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22846,
"upload_time": "2024-04-23T12:45:29",
"upload_time_iso_8601": "2024-04-23T12:45:29.941537Z",
"url": "https://files.pythonhosted.org/packages/e0/52/4135165cee7e25b4014fbe09f5126cf348d3be03caac08cdbb41fe68dec7/pygrocy-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 12:45:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sebrut",
"github_project": "pygrocy",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pygrocy"
}
JSON
