{"id":48575955,"url":"https://github.com/ricpol/pygrister","last_synced_at":"2026-04-08T15:42:47.958Z","repository":{"id":239462654,"uuid":"799592394","full_name":"ricpol/pygrister","owner":"ricpol","description":"A Python client for the Grist API","archived":false,"fork":false,"pushed_at":"2026-02-21T11:39:47.000Z","size":397,"stargazers_count":36,"open_issues_count":2,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-02-21T17:50:13.831Z","etag":null,"topics":["cli","database","grist","spreadsheet"],"latest_commit_sha":null,"homepage":"https://pygrister.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ricpol.png","metadata":{"files":{"readme":"readme.rst","changelog":"NEWS.txt","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-12T15:48:13.000Z","updated_at":"2026-02-21T11:39:51.000Z","dependencies_parsed_at":"2024-05-12T17:26:59.082Z","dependency_job_id":"3ec59b4a-c68f-42a3-9208-eb0c14777244","html_url":"https://github.com/ricpol/pygrister","commit_stats":null,"previous_names":["ricpol/pygrister"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ricpol/pygrister","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricpol%2Fpygrister","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricpol%2Fpygrister/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricpol%2Fpygrister/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricpol%2Fpygrister/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ricpol","download_url":"https://codeload.github.com/ricpol/pygrister/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricpol%2Fpygrister/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31562696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","database","grist","spreadsheet"],"created_at":"2026-04-08T15:42:47.360Z","updated_at":"2026-04-08T15:42:47.950Z","avatar_url":"https://github.com/ricpol.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pygrister: a Python client for the Grist API.\n=============================================\n\n`Grist \u003chttps://www.getgrist.com/\u003e`_ is a relational spreadsheet with tons of \nbatteries included. The `Grist API \u003chttps://support.getgrist.com/api\u003e`_ \nallows you to programmatically retrieve/update your data stored on Grist, \nand manipulate most of the basic Grist objects, such as workspaces, documents, \nuser permissions and so on. \n\nPygrister is a Grist client that covers all the documented APIs. \nPygrister keeps track of basic configuration for you, remembering your \nteam site, workspace, working document, so that you don't have to type in \nthe boring stuff every time. Apart from this and little else, Pygrister \nis rather low-level: it will call the api and retrieve the response, with \nonly minor changes. \nIf the api call is malformed, you will simply receive a bad HTTP status code. \n\nBasic usage goes as follows::\n\n    from pygrister.api import GristApi\n\n    grist = GristApi()\n    # list users/permissions for the current document\n    status_code, response = grist.list_doc_users()\n    # fetch all rows in a table\n    status_code, response = grist.list_records('Table1') \n    # add a column to a table\n    cols = [{'id': 'age', 'fields': {'label':'age', 'type': 'Int'}}]\n    status_code, response = grist.add_cols('Table1', cols) \n\nYou should `read the docs first \u003chttps://pygrister.readthedocs.io\u003e`_, \nand then take a look at the test suite for more usage examples. \n\nGry: the Grist cli tool.\n------------------------\n\nGry is a command line tool to query the Grist Api. Gry is based on Pygrister, \nbut you can use/vendor it as a stand-alone tool, with no prior Python/Pygrister \nknowledge needed. \n\nIn fact, **Gry is also available as a stand-alone bundle**: you may download \nthe \"gry.zip\" file (right now, Windows only) from the \n`latest release page on GitHub \u003chttps://github.com/ricpol/pygrister/releases\u003e`_. \nThe stand-alone version of Gry doesn't need Python pre-installed on your machine: \njust unzip the file, and you are ready to use Gry. \n\nOr, if you have installed Pygrister (see below), you will find that Gry \nis also included: to try it out, just type ::\n\n    % gry --help    # % is your shell prompt\n\nand find out what Gry can do for you (or, read the online documentation!).\n\nBasic usage goes as follows::\n\n    % gry team see  # get info on the \"default\" team as per config\n    % gry doc see  # the \"default\" document as per config\n    % gry doc see -d f4Y8Tov7TRkTQfUuj7TVdh  # select a specific document\n    \n    # the best way to switch to another document, from now on: \n    % export GRIST_DOC_ID=f4Y8Tov7TRkTQfUuj7TVdh  # or \"set\" in windows\n    % gry doc see  # the same as above, but no need to add the \"-d\" option\n    % gry doc see -d bogus_doc  # now this will fail...\n    % gry doc see -d bogus_doc -i  # ...so let's see the request details \n    \n    % gry ws see -w 42  # workspace info, in a nicely formatted table\n    % gry ws see -w 42 -vv  # the same, in the original raw json\n    \n    % gry table new --help  # how do I add a table?\n    % gry table new name:Text:Name age:Int:Age --table People  # like this!\n    \n    % gry col list -b People  # the columns of our new table\n    % gry rec new name:\"John Doe\" age:42 -b People  # populate the table\n    \n    % gry sql \"select * from People where age\u003e?\" -p 35  # run an sql query\n    % gry python  # let's open a Python shell now!\n    \u003e\u003e\u003e gry.list_cols(table_id='People')  # \"gry\" is now a python object\n    \u003e\u003e\u003e exit()  # and we are back to the shell\n\n\nPython version required.\n------------------------\n\nPygrister (and Gry) will work with any Python\u003e=3.10 (the code itself  \nworks against Py3.9 too, if not for our use of the \"pipe\" syntax ``type|type`` \nin type checking: backporting should be trivial.)\n\nNote that Grist itself may have \n`stricter Python requirements \u003chttps://support.getgrist.com/python/#supported-python-versions\u003e`_ \nbut don't mix things up: the Grist's Python lives on the server, supporting \na Grist instance. You will likely run Pygrister from a client instead, with \nyour Python of choice. \n\nInstall.\n--------\n\nAny feedback and contribution is *very welcome* at this stage! \n\nRight now, Pygrister is in beta stage, meaning that the overall interface \nshould be fairly stable but I make no promises about further changes. \nThe new Scim api support is still *very* experimental. \n\nYou can install Pygrister from PyPI::\n\n    python -m pip install pygrister\n\nNote that this repo may have recent features not yet released on PyPI: \nsee ``NEWS.txt`` and/or the commit history. To try the \"bleeding edge\" \nfrom GitHub::\n\n    python -m pip install git+https://github.com/ricpol/pygrister\n\nLicense.\n--------\n\nPygrister/Gry is released under the MIT license (see ``LICENSE.rst``). \nCopyright 2024-2026 Riccardo Polignieri\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricpol%2Fpygrister","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fricpol%2Fpygrister","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricpol%2Fpygrister/lists"}