Skip to content
forTEXTPublic

About

Python package to access and process CATMA projects via the CATMA GitLab backend

Topics

Resources

Contributing

Stars

9 stars

Watchers

4 watching

Forks

Repository files navigation

GitMA

Documentation DOI Binder

Description

Python package to access and process CATMA projects via the CATMA GitLab backend.

This package makes use of CATMA's Git Access. For further information see the GitMA Documentation.

Demo Jupyter Notebooks and Docker Image

You'll find 4 Jupyter Notebooks in the demo/notebooks directory:

We have also created a ready to use Docker image that includes GitMA and all dependencies, as well as the above notebooks. This is a good way to see what GitMA can do.

To run the notebooks from a clone of this repository instead, sync the notebooks dependency group, which provides JupyterLab:

uv sync --group notebooks
uv run jupyter lab

JupyterLab is deliberately not a dependency of the library itself, so installing GitMA does not pull in the whole Jupyter stack; the Docker image and Binder each bring their own.

Installation

GitMA requires Python 3.13 (3.14 is not supported yet) and is installed directly from this repository:

pip install git+https://github.com/forTEXT/gitma

If you manage your project with uv, add it with:

uv add git+https://github.com/forTEXT/gitma

To pin a specific release, append the tag:

pip install git+https://github.com/forTEXT/gitma@2.2.1

Gamma agreement support is an optional extra:

pip install "gitma[pygamma] @ git+https://github.com/forTEXT/gitma"

Releases from 2.2.0 onwards also have a prebuilt wheel and source distribution attached, which you can install instead of building from the repository.

Cloning and reading a project works with GitMA alone. Updating a project or pushing annotations back to CATMA also requires a git installation with saved credentials for your CATMA account - see Additional Notes.

For a local development setup see CONTRIBUTING.md.

Contributing and Releases

Additional Notes

Git related functionality is implemented using pygit2. Make sure to have the access token for CATMA Gitlab instance. See the demo notebooks for instructions on how to set up the access token.

About

Python package to access and process CATMA projects via the CATMA GitLab backend

Topics

Resources

Contributing

Stars

9 stars

Watchers

4 watching

Forks

Releases

Used by

Contributors

Languages