tgadmin 0.28.1

TextGrid repository administration cli tool, based on tgclients

tgadmin

A command line tool for managing your projects in the TextGrid repository without TextGridLab.

Install

You may use this with venv or with pipx. With pipx you have the benefit of having the command available in your shell without further manual venv creation and activation.

Install pipx, e.g. on Debian/Ubuntu apt install pipx

And the this tool from pypi.org

    pipx install tgadmin

Upgrade to a new version with

    pipx upgrade tgadmin

If you do not want to use pipx have a look at the section "Development".

Usage

Export sessionID (SID)

get from https://textgridlab.org/1.0/Shibboleth.sso/Login?target=/1.0/secure/TextGrid-WebAuth.php?authZinstance=textgrid-esx2.gwdg.de

and set as env var:

    export TEXTGRID_SID=your_secret_sid_here

or set with --sid for every command

Get help

    tgadmin

List projects

list your projects:

    tgadmin list

Create project

if there is no suitable project, create one:

    tgadmin create lab-import-test-20230605

Upload an aggregation object like editons, aggregations and collections

You can upload aggregations as new textgrid objects like

    tgadmin --server http://test.textgridlab.org put-aggregation TGPR-...fe eng003.edition

this would assume that you have an file containing the aggragtion with local paths in eng003.edition and metadata description files like eng003.edition.meta. After initial uploads you find an filename.imex which has a mapping of lokal file names to textgrid URIs. This can be used to update the objects from the edition like:

    tgadmin --server http://test.textgridlab.org update-imex eng003.edition.imex .

Advanced Usage

You may use the development or the test instance of the TextGrid Server.

To use tgadmin with the test instance do

    tgadmin --server https://test.textgridlab.org list

for the dev system there is a shortcut, you may call

    tgadmin --dev list

shell completion

    _TGADMIN_COMPLETE=bash_source tgadmin > tgadmin-complete.bash
    . tgadmin-complete.bash

Development

clone repo

    git clone https://gitlab.gwdg.de/dariah-de/textgridrep/tgadmin.git
    cd tgadmin

and create venv

    python3 -m venv venv
    . venv/bin/activate
    pip install --editable .[dev]

afterwards tgadmin is in your venv as command and can be executed

    tgadmin

run integration tests and check coverage

    export PROJECT_ID=[my-project-id]
    export TEXTGRID_SID=[my-session-id]
    coverage run -m pytest --junitxml=report.xml && coverage html

Contributing

Commit convention:

• Use conventional commits

Style constraints:

• Code: PEP 8
• Documentation: Google style docstrings (Chapter 3.8 from Google styleguide)

Coding constraints:

For your convenience, pre-commit hooks are configured to check against these constraints. Provided, you have installed the development requirements (see above), activate pre-commit to run on ever y git commit:

    pre-commit install

Badges