Heimdall - Grist connector

https://www.repostatus.org/badges/latest/wip.svg

https://img.shields.io/badge/documentation-api-green

https://gitlab.huma-num.fr/datasphere/heimdall/connectors/grist/python/badges/main/pipeline.svg

https://gitlab.huma-num.fr/datasphere/heimdall/connectors/grist/python/badges/main/coverage.svg

What is this?

Heimdall is a tool for converting more easily one or more databases from one format to another. It leverages modules called “connectors”, responsible for conversion of data between specific databases schemas and the HERA format.

This repository contains a connector to any Grist server, eg. grist.numerique.gouv.fr.

Why should I use it?

You can use this connector, along with the pyheimdall software, to retrieve any data from any Grist server. You can then aggregate this data into your research corpus easily, for example using other Heimdall connectors.

Take note, however that some legal restrictions might apply to data retrieved from Grist.

Plus, if at the end of your project, you share your data, please cite the original data properly (and reuploading it elsewhere is probably a bad idea, too).

How can I use it?

Setup

This Grist pyHeimdall connector is available as a PyPI package named pyheimdall-grist. You can install it using the pip package manager:

pip install pyheimdall-grist

You can use pip to either upgrade or uninstall this connector, too:

pip install --upgrade pyheimdall-grist
pip uninstall pyheimdall-grist

Usage

import heimdall

db = heimdall.getDatabase(format='grist:api', database='documentId')
heimdall.createDatabase(db, format='grist:api')

Please note that you don’t need to use pyheimdall-grist functions directly. As long as the package is installed on your system, pyHeimdall will automatically discover its features and allow you to use them as long as any other default or external connector.

Is it documented?

Sure! Here’s the link.

Is it tested?

Of course! Here’s the coverage report.

How can I contribute?

PyHeimdall welcomes any feedback or proposal. Details can be accessed here

License

GNU Affero General Public License version 3.0 or later

Release files for pyheimdall-grist 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyheimdall-grist 0.4.0
File	Size	Uploaded
pyheimdall_grist-0.4.0.tar.gz	16.8 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pyheimdall-grist 0.4.0
File	Interpreter	ABI	Platform	Reset
pyheimdall_grist-0.4.0-py2.py3-none-any.whl 18.6 kB Sep 25, 2026	Python 2, Python 3	none	any	Details

Total release size: 35.4 kB

Release files / pyheimdall_grist-0.4.0.tar.gz

Download URL	pyheimdall_grist-0.4.0.tar.gz
Size	16.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`937851341e262e11c60fce790412ded0025b58784b133c54fee084ea5d9ba07d`
BLAKE2b-256 checksum How to use checksums	`6517ec8d926f474b14dd3e8c6e8fe05d2de0a914385667abc116b775bc65c499`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.11`

Release files / pyheimdall_grist-0.4.0-py2.py3-none-any.whl

Download URL	pyheimdall_grist-0.4.0-py2.py3-none-any.whl
Size	18.6 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`0d1940178af03f4659a946af9185ee205b788049ec2e8fd221ff8fab2310ba98`
BLAKE2b-256 checksum How to use checksums	`0dc342fc6d0d834663acfbe978395c052a758a233dd540ef4381e89976f63f75`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.11`