dcc¶
dcc is a Python-based, primarily command line driven tool for interacting with the
LIGO DCC and similar document servers based on DocDB.
dcc attempts to provide a powerful yet intuitive and user-friendly command line
interface to the DCC, allowing for quick and automated retrieval and update of records
and files.
Features¶
Interactive command line interface
Retrieval, modification and archival of DCC record metadata and attachments
URL scraping and automatic, recursive archival of related documents and files
Easy to install¶
dcc is available on PyPI, installable using your
favourite package manager, e.g.:
$ pip install dcc
See Installation.
Easy to use¶
View a DCC record:
$ dcc view T010075
number: T010075-v3
url: https://dcc.ligo.org/T010075-v3
title: Advanced LIGO Systems Design
...etc...
Archive a record and its files locally:
$ dcc archive -s /path/to/archive T010075 --files
$ tree /path/to/archive
/path/to/archive
└── T010075
└── T010075-v3
├── Change Record for T010075-v3.docx
├── Change Record for T010075-v3.pdf
├── meta.toml
├── T010075-v3 aLIGO System Description.pdf
└── T010075-v3 System Description.zip
Get help:
$ dcc --help
Usage: dcc [OPTIONS] COMMAND [ARGS]...
dcc 0.8.0
Tools for viewing and updating records, metadata and files in the LIGO
Document Control Center (DCC).
Website: https://docs.ligo.org/sean-leavey/dcc/
dcc comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
welcome to redistribute it under certain conditions. See the GNU General
Public Licence for details.
Copyright 2022 Sean Leavey, Jameson Graef Rollins, Christopher Wipf
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
archive Archive remote DCC records locally.
convert Extract DCC numbers from a target file or URL.
list List records in the local archive.
open Open remote DCC record page in the default browser.
open-file Open file attached to DCC record using operating system.
update Update remote DCC record metadata.
view View DCC record metadata.
See Quick start.