Newer
Older
<!--
SPDX-FileCopyrightText: 2024 Georg-August-Universität Göttingen
SPDX-License-Identifier: CC0-1.0
-->
# tgadmin
A command line tool for managing your projects in the [TextGrid repository](https://textgridrep.org) 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](https://pypa.github.io/pipx/), e.g. on Debian/Ubuntu `apt install pipx`
And the this tool from [pypi.org](https://pypi.org/project/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".
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
list your projects:
tgadmin list
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
## 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
## Badges
[![REUSE status](https://api.reuse.software/badge/gitlab.gwdg.de/dariah-de/textgridrep/tgadmin)](https://api.reuse.software/info/gitlab.gwdg.de/dariah-de/textgridrep/tgadmin)
[![PyPI](https://img.shields.io/pypi/v/tgadmin)](https://pypi.org/project/tgadmin/)