Commit a4fb6430 authored by Sean Leavey's avatar Sean Leavey
Browse files

Update project name and descriptions (fixes #20)

parent ad5662c0
# DCC API
# DCC - a LIGO DCC command line utility
An API for the [LIGO Scientific Collaboration](http://www.ligo.org/)
A utility providing command line access to the
[LIGO Scientific Collaboration](http://www.ligo.org/)
[Document Control Center](https://dcc.ligo.org/) (DCC).
## Features
......@@ -21,8 +22,8 @@ An API for the [LIGO Scientific Collaboration](http://www.ligo.org/)
- (Optional) [graphviz](https://pypi.python.org/pypi/graphviz) for Python
LIGO.ORG credentials are given to members of the interferometric gravitational
wave community and are not publicly available. The API may work with the public
DCC without these credentials, but it has not been tested.
wave community and are not publicly available. Document access may work with the
public DCC without these credentials, but it has not been tested.
The `graphviz` package is for creating graphs of connected DCC documents, and
is optional if you don't need to do this.
......@@ -32,7 +33,7 @@ Before doing anything else, add the `dcc` package to your Python path.
### Kerberos authentication
You must obtain a Kerberos token to authenticate yourself against the LIGO
Kerberos directory, otherwise `dcc-api` will not be able to obtain a session
Kerberos directory, otherwise `dcc` will not be able to obtain a session
cookie to access the DCC. This is one possible way to authenticating with
Kerberos:
```bash
......@@ -44,7 +45,7 @@ case sensitive.
Note: you can also revoke your Kerberos token later with `kdestroy`.
### Command line interpreter
`dcc-api` has a command line interpreter. In your terminal, type
`dcc` has a command line interpreter. In your terminal, type
```bash
python3 -m dcc help
```
......@@ -151,7 +152,7 @@ DCC documents, authors and more. There is an example provided in
`examples/graph.py`.
### Logging
`DCC API` has logging capabilities. To log to `stdout`, just put this at the
`dcc` has logging capabilities. To log to `stdout`, just put this at the
top of your script:
```python
import logging
......
# -*- coding: utf-8 -*-
"""DCC API"""
"""LIGO DCC command line utility"""
import logging
......
......@@ -27,13 +27,13 @@ test_requirements = [
]
setup(
name="dcc-api",
name="dcc",
version=__version__,
description="An API for the LIGO Scientific Collaboration Document Control Centre (DCC).",
description="A command line utility for the LIGO Scientific Collaboration Document Control Centre (DCC).",
long_description=readme + "\n\n" + history,
author="Sean Leavey",
author_email="sean.leavey@ligo.org",
url="https://git.ligo.org/sean-leavey/dcc-api",
url="https://git.ligo.org/sean-leavey/dcc",
packages=[
"dcc"
],
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment