Human Cell Atlas Data Storage System Command Line Interface
Project description
This repository contains a command line interface (CLI) and Python library for interacting with the Data Coordination Platform (DCP) of the Human Cell Atlas (HCA). Currently it allows interaction with the Upload Service and Data Storage Service (DSS).
Installation
pip install hca.
Usage
The hca package installs a command-line utility hca.
To see the list of commands you can use, type hca --help. Commands are grouped into major categories that
roughly correspond to DCP system components, e.g. DSS, Staging Service. To get detailed help for a particular
command group type, e.g. hca upload --help.
Configuration management
The HCA CLI supports ingesting configuration from a configurable array of sources. Each source is a JSON file. Configuration sources that follow the first source update the configuration using recursive dictionary merging. Sources are enumerated in the following order (i.e., in order of increasing priority):
Site-wide configuration source, /etc/hca/config.json
User configuration source, ~/.config/hca/config.json
Any sources listed in the colon-delimited variable HCA_CONFIG_FILE
Command line options
Array merge operators: When loading a chain of configuration sources, the HCA CLI uses recursive dictionary merging to combine the sources. Additionally, when the original config value is a list, the package supports array manipulation operators, which let you extend and modify arrays defined in underlying configurations. See https://github.com/kislyuk/tweak#array-merge-operators for a list of these operators.
Development
To develop on the CLI, first run pip install -r requirements-dev.txt. You can install your locally modified copy of the hca package by running make install in the repository root directory.
To use the command line interface with a local or test DSS, first run hca (or scripts/hca if you want to use the package in place from the repository root directory). This will create the file ~/.config/hca/config.json, which you can modify to update the value of DSSClient.swagger_url to point to the URL of the Swagger definition served by your DSS deployment. You can also layer a minimal config file on top of the default config.json using the HCA_CONFIG_FILE environment variable, for example:
export SWAGGER_URL="https://dss.staging.data.humancellatlas.org/v1/swagger.json" jq -n .DSSClient.swagger_url=env.SWAGGER_URL > ~/.config/hca/config.staging.json export HCA_CONFIG_FILE=~/.config/hca/config.staging.json
To use the Python interface with a local or test DSS, set the host attribute of the API client:
client = hca.dss.DSSClient()
client.host = "https://dss.example.com/v1"
res = client.post_search(...)Testing
Before you run tests, first run hca dss login. This will pop up a browser and get you to authenticate with Google. Use an email from one of the whitelisted domains (in DSS_SUBSCRIPTION_AUTHORIZED_DOMAINS_ARRAY from here).
Then make test.
Bugs
Please report bugs, issues, feature requests, etc. on GitHub.
License
Licensed under the terms of the MIT License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hca-3.1.1.tar.gz.
File metadata
- Download URL: hca-3.1.1.tar.gz
- Upload date:
- Size: 31.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9b2fdff2a0029cbd8e36889554341bf4b8a25ee919ce1ec863d5262643f0ab4 |
|
| MD5 | 86beabf1ea99fde405f84456c6ec3b39 |
|
| BLAKE2b-256 | dfc2b663bbce198f7772faead86bc47504ca31f3f1ade0ad7bb4cf43e13922f1 |
Provenance
File details
Details for the file hca-3.1.1-py2.py3-none-any.whl.
File metadata
- Download URL: hca-3.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 45.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae0873a03f2ed3f3a34cd21f13d7335a5f1f4474306c14a14a077ddb6fd5d751 |
|
| MD5 | 57058701fd5f06dfb7739828b57e6d12 |
|
| BLAKE2b-256 | b08d6ae083de4aaa39f4cb2d923e2bdd454b90d14b709545d5134d4f90512428 |
