| Name | Pygrister JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | A Python client for the Grist API. |
| upload_time | 2024-06-15 13:20:51 |
| maintainer | None |
| docs_url | None |
| author | Riccardo Polignieri |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Riccardo Polignieri Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
grist
relational spreadsheet
database
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Pygrister: a Python client for the Grist API.
=============================================
`Grist <https://www.getgrist.com/>`_ is a relational spreadsheet with tons of
batteries included. The `Grist API <https://support.getgrist.com/api>`_
allows you to programmatically retrieve/update your data stored on Grist,
and manipulate most of the basic Grist objects, such as workspaces, documents,
user permissions and so on.
Pygrister is a Grist client that covers all the documented APIs.
Pygrister keeps track of basic configuration for you, remembering your
team site, workspace, working document, so that you don't have to type in
the boring stuff every time. Apart from this and little else, Pygrister
is rather low-level: it will call the api and retrieve the response, with
only minor changes.
If the api call is malformed, you will simply receive a bad HTTP status code.
Basic usage goes as follows::
from pygrister.api import GristApi
grist = GristApi()
# list users/permissions for the current document
status_code, response = grist.list_doc_users()
# fetch all rows in a table
status_code, response = grist.list_records('Table1')
# add a column to a table
cols = [{'id': 'age', 'fields': {'label':'age', 'type': 'Int'}}]
status_code, response = grist.add_cols('Table1', cols)
You should `read the docs first <https://pygrister.readthedocs.io>`_,
and then take a look at the test suite for more usage examples.
Install.
--------
Right now, Pygrister is in beta stage, meaning that the overall interface
should be fairly stable but I still make no promises about further changes.
You can install Pygrister from PyPI::
python -m pip install pygrister
What's next.
------------
- Add support for some other useful, *undocumented* Grist Apis;
- Add at least a basic type system for records;
- Maybe write a few "macros/recipes" for common Grist tasks...
Any feedback and contribution is *very welcome* at this stage!
License.
--------
Pygrister is released under the MIT license (see ``LICENSE.rst``).
Copyright 2024 Riccardo Polignieri
Raw data
{
"_id": null,
"home_page": null,
"name": "Pygrister",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Grist, relational spreadsheet, database, API",
"author": "Riccardo Polignieri",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f6/3c/09ba6366ca076090ef668ae15912e60770ae0d6e3283d2feb1552c9746ba/pygrister-0.4.0.tar.gz",
"platform": null,
"description": "Pygrister: a Python client for the Grist API.\r\n=============================================\r\n\r\n`Grist <https://www.getgrist.com/>`_ is a relational spreadsheet with tons of \r\nbatteries included. The `Grist API <https://support.getgrist.com/api>`_ \r\nallows you to programmatically retrieve/update your data stored on Grist, \r\nand manipulate most of the basic Grist objects, such as workspaces, documents, \r\nuser permissions and so on. \r\n\r\nPygrister is a Grist client that covers all the documented APIs. \r\nPygrister keeps track of basic configuration for you, remembering your \r\nteam site, workspace, working document, so that you don't have to type in \r\nthe boring stuff every time. Apart from this and little else, Pygrister \r\nis rather low-level: it will call the api and retrieve the response, with \r\nonly minor changes. \r\nIf the api call is malformed, you will simply receive a bad HTTP status code. \r\n\r\nBasic usage goes as follows::\r\n\r\n from pygrister.api import GristApi\r\n\r\n grist = GristApi()\r\n # list users/permissions for the current document\r\n status_code, response = grist.list_doc_users()\r\n # fetch all rows in a table\r\n status_code, response = grist.list_records('Table1') \r\n # add a column to a table\r\n cols = [{'id': 'age', 'fields': {'label':'age', 'type': 'Int'}}]\r\n status_code, response = grist.add_cols('Table1', cols) \r\n\r\nYou should `read the docs first <https://pygrister.readthedocs.io>`_, \r\nand then take a look at the test suite for more usage examples. \r\n\r\nInstall.\r\n--------\r\n\r\nRight now, Pygrister is in beta stage, meaning that the overall interface \r\nshould be fairly stable but I still make no promises about further changes. \r\n\r\nYou can install Pygrister from PyPI::\r\n\r\n python -m pip install pygrister\r\n\r\nWhat's next.\r\n------------\r\n\r\n- Add support for some other useful, *undocumented* Grist Apis; \r\n- Add at least a basic type system for records;\r\n- Maybe write a few \"macros/recipes\" for common Grist tasks... \r\n\r\nAny feedback and contribution is *very welcome* at this stage! \r\n\r\nLicense.\r\n--------\r\n\r\nPygrister is released under the MIT license (see ``LICENSE.rst``). \r\nCopyright 2024 Riccardo Polignieri\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Riccardo Polignieri Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python client for the Grist API.",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/ricpol/pygrister/issues",
"Changelog": "https://github.com/ricpol/pygrister/blob/main/NEWS.txt",
"Documentation": "https://pygrister.readthedocs.io",
"Repository": "https://github.com/ricpol/pygrister"
},
"split_keywords": [
"grist",
" relational spreadsheet",
" database",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee3973e15d8007ead6ee6f9a467bcb4c61b3d9f58a95d22f26fa8ffbb228a913",
"md5": "8ff7142b31e937d80fa17c46440e7c1d",
"sha256": "2496d7df45914735779977fba2991bd89619108bd61ce52135d7f93f91cad9c9"
},
"downloads": -1,
"filename": "Pygrister-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ff7142b31e937d80fa17c46440e7c1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 11950,
"upload_time": "2024-06-15T13:20:50",
"upload_time_iso_8601": "2024-06-15T13:20:50.207833Z",
"url": "https://files.pythonhosted.org/packages/ee/39/73e15d8007ead6ee6f9a467bcb4c61b3d9f58a95d22f26fa8ffbb228a913/Pygrister-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f63c09ba6366ca076090ef668ae15912e60770ae0d6e3283d2feb1552c9746ba",
"md5": "96c605f1dc9b60815771913382b63ebe",
"sha256": "7bbb04c8974bbb5b300ac9ab7ae6616dc80a49701c09bef811165f55fbc8b6b4"
},
"downloads": -1,
"filename": "pygrister-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "96c605f1dc9b60815771913382b63ebe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15681,
"upload_time": "2024-06-15T13:20:51",
"upload_time_iso_8601": "2024-06-15T13:20:51.936778Z",
"url": "https://files.pythonhosted.org/packages/f6/3c/09ba6366ca076090ef668ae15912e60770ae0d6e3283d2feb1552c9746ba/pygrister-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-15 13:20:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ricpol",
"github_project": "pygrister",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "pygrister"
}
