cdstarcat

Manage objects in a CDSTAR instance using a local catalog.

Install

Running

pip install cdstarcat

will install the cdstarcat package as well as a commandline interface cdstarcat.

For developing cdstarcat, clone the repository clld/cdstarcat and run

cd cdstarcat
pip install -r requirements.txt

CLI

Run

cdstarcat --help

to get a list of available subcommands, and

cdstarcat help SUBCOMMAND

to get usage information for a particular subcommand.

cdstarcat API

Typically, cdstarcat will be used programmatically, to implement recurring media file maintenance tasks within projects - such as uploading media files for a new submission to Dictionaria.

In the simplest case this could look as follows:

import os
from cdstarcat import Catalog

def upload(directory):
    with Catalog(
        os.environ['CDSTAR_CATALOG'],
        cdstar_url=os.environ['CDSTAR_URL'],
        cdstar_user=os.environ['CDSTAR_USER'],
        cdstar_pwd=os.environ['CDSTAR_PWD']
    ) as cat:
        md = {
            'collection': 'PROJECT NAME',
            'path': '%s' % directory,
        }
        for fname, created, obj in cat.create(directory, md):
            print('{0} -> {1}'.format(fname, obj.id))