cidc-cli 0.9.17

A command-line interface for interacting with the CIDC.

Branch	Status	License
Master

CIDC-CLI

Command line tool for interfacing with the CIDC API.

Setup

Install the CIDC-CLI

pip3 install cidc-cli

Run the CIDC-CLI

To display the help message for the CLI, run:

cidc

To authenticate with the CIDC API, run:

cidc login [token]

Development

For local development, first install the development dependencies:

pip install -r requirements.dev.txt

Then, install and configure the pre-commit hooks:

pre-commit install

JIRA Integration

To set-up the git hook for JIRA integration, run:

ln -s ../../.githooks/commit-msg .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg
rm .git/hooks/commit-msg.sample

This symbolic link is necessary to correctly link files in .githooks to .git/hooks. Note that setting the core.hooksPath configuration variable would lead to pre-commit failing. The commit-msg hook runs after the pre-commit hook, hence the two are de-coupled in this workflow.

To associate a commit with an issue, you will need to reference the JIRA Issue key (For eg 'CIDC-1111') in the corresponding commit message.