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.:
.. code-block:: text
$ pip install dcc
See :ref:`installation`.
Easy to use
-----------
View a DCC record:
.. code-block:: text
$ 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:
.. code-block:: text
$ 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:
.. command-output:: dcc --help
See :ref:`quick_start`.
Full contents
-------------
.. toctree::
:maxdepth: 2
installation
quick-start
usage
examples
cli
developers
api
Indices and tables
==================
* :ref:`genindex`