DataONEorg / DataONE_Operations

Operations documentation for DataONE infrastructure
Apache License 2.0
1 stars 1 forks source link

DataONE_Operations

Utilities for administrative operations in DataONE.

Several of these utilities require administrative access to DataONE servers, and so are not appropriate for general end-user use.

Documentation

See also the operations docs in subversion:

.. _Wiki: https://github.com/DataONEorg/DataONE_Operations/wiki

Installation

Installs a locally editable version of the tools:

  1. Checkout this project from GitHub

  2. cd to the project

  3. Create a virtual environment. If you have direnv installed, then the python virtual environment venv is created for you. Otherwise, python -m venv venv.

4.. pip install -U -e .

Initialization

The scripts rely on configuration information that by default is located in::

${HOME}/.dataone/d1_config.json

A default config can be generated by running::

python d1_admin_tools/d1_config.py -i

The Scripts

All scripts are meant to be run from a BASH command line (untested on windows), send output to stdout. Output in text, json, and sometimes xml is supported.

May be out of date:

Code style

See https://github.com/DataONEorg/d1_python#code-style