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 dss --help.
When it is necessary to provide a list of things to a command put them in a single string separated with slashes, e.g.
True/Bob/3806d74a-6ab5-4a6d-ba00-667ea858c7b5/2017-06-30T19:33:38+00:00.
Development
To develop on the CLI, first run pip install -r requirements-dev.txt.
To use the command line interface with a local or test DSS, open <directory_holding_hca_module>/hca/api_spec.json.
Change host to the host you want (if you’re running on a local DSS, this will likely be localhost:5000)
and the first argument of schemes should be the scheme you want (http if running locally,
https otherwise).
Code Generation
Some parts of the CLI are auto-generated from the OpenAPI (Swagger) Specifications (OAS). The Python bindings have to be regenerated to reflect any api changes. To regenerate these, run make bindings. Only package maintainers should run this command and publish new package versions.
Testing
Before you run tests, do an 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-2.3.0.tar.gz.
File metadata
- Download URL: hca-2.3.0.tar.gz
- Upload date:
- Size: 44.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7fef50015e8430bb45cd9920d01ba53b957c2a49566e1d2a3f478cf3bf634031 |
|
| MD5 | 466d764a8631698c1676618f4970c2f2 |
|
| BLAKE2b-256 | fc3164e7e695d7ef43b961099237404dda0381a77ef151b3420c98f30940753d |
Provenance
File details
Details for the file hca-2.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: hca-2.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 118.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd75ef3aacc4e6951f7071fe59be208bc83eeaab674a80f2c2703497d6568499 |
|
| MD5 | 8bb0ae744e0d0dbf45d789db502a90fc |
|
| BLAKE2b-256 | 0b926407ff0dfaca76cee0a5fb442ba18a3919a2b2bc3d5d46af1908b68c3d8d |
