| Name | hubmap-clt JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | |
| Summary | A command line interface to download multiple files and directories from Globus file transfer service using a manifest file. |
| upload_time | 2023-04-07 17:23:37 |
| maintainer | |
| docs_url | None |
| author | Hubmap |
| requires_python | >=3.6 |
| license | |
| keywords |
hubmap clt
python
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hubmap-clt
---
A command line interface to download multiple files and directories from the Globus file transfer service.
### Overview
The HuBMAP Command-Line Transfer uses the Globus cli to transfer files from a manifest file. This file contains the ID (UUID or HuBMAP ID) and the path to the specific file or directory to be downloaded.
### Installing and Using hubmap-clt
The HuBMAP Command-Line Transfer requires a local Globus Connect Personal Endpoint to be connected. The user must have an account with Globus and be logged into both the local endpoint as well as the Globus command line interface. Hubmap-clt is available through PyPi and can be installed with:
```bash
pip3 hubmap-clt
```
hubmap-clt requirements can be found [here](requirements.txt)
Consult <a href="https://software.docs.hubmapconsortium.org/">Installing hubmap-clt</a> and Consult <a href="https://software.docs.hubmapconsortium.org/">Using hubmap-clt</a> for full documentation on getting started with hubmap-clt as we as information on the required Globus software.
### Building and Publishing hubmap-clt
<a href="https://pypi.org/project/setuptools/">SetupTools</a> and <a href="https://pypi.org/project/wheel/">Wheel</a> is required to build the clt distribution. <a href="https://pypi.org/project/twine/">Twine</a> is required to publish to Pypi
Build the distribution directory with:
```bash
python3 setup.py sdist bdist_wheel
```
from within the hubmap-clt project directory
To publish, from inside the project directory, run:
```bash
twine upload dist/*
```
A prompt to enter login information to the hubmap Pypi account will appear
### Files
This code contains:
**\_\_main\_\_.py**: Contains the implementation of the command-line interface as well as the logic for the clt.
Inside of **\_\_main\_\_.py** are the following classes:
* whoami: Informs the user if they are logged into Globus
* login: Initiates a Globus login using the default web browser
* transfer: Sets up a transfer into the user's downloads file. Accepts a single required argument. This argument is the name of a manifest file which contains information on the files to be downloaded
* batch_transfer: Calls globus batch transfer for each source collection represented in the manifest file.
Raw data
{
"_id": null,
"home_page": "",
"name": "hubmap-clt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "HuBMAP CLT,python",
"author": "Hubmap",
"author_email": "api-developers@hubmapconsortium.org",
"download_url": "https://files.pythonhosted.org/packages/00/b6/2881105ca0d7f7e392d90e627c60055b23a080657176bd6da8fe277f1d35/hubmap-clt-1.1.3.tar.gz",
"platform": null,
"description": "# hubmap-clt\n\n---\n\nA command line interface to download multiple files and directories from the Globus file transfer service.\n\n### Overview\n\nThe HuBMAP Command-Line Transfer uses the Globus cli to transfer files from a manifest file. This file contains the ID (UUID or HuBMAP ID) and the path to the specific file or directory to be downloaded. \n\n### Installing and Using hubmap-clt\n\nThe HuBMAP Command-Line Transfer requires a local Globus Connect Personal Endpoint to be connected. The user must have an account with Globus and be logged into both the local endpoint as well as the Globus command line interface. Hubmap-clt is available through PyPi and can be installed with:\n\n```bash\npip3 hubmap-clt\n```\n\nhubmap-clt requirements can be found [here](requirements.txt)\n\nConsult <a href=\"https://software.docs.hubmapconsortium.org/\">Installing hubmap-clt</a> and Consult <a href=\"https://software.docs.hubmapconsortium.org/\">Using hubmap-clt</a> for full documentation on getting started with hubmap-clt as we as information on the required Globus software. \n\n### Building and Publishing hubmap-clt\n\n<a href=\"https://pypi.org/project/setuptools/\">SetupTools</a> and <a href=\"https://pypi.org/project/wheel/\">Wheel</a> is required to build the clt distribution. <a href=\"https://pypi.org/project/twine/\">Twine</a> is required to publish to Pypi\n\nBuild the distribution directory with: \n\n```bash\npython3 setup.py sdist bdist_wheel\n```\n\nfrom within the hubmap-clt project directory\n\nTo publish, from inside the project directory, run:\n\n```bash\ntwine upload dist/*\n```\n\nA prompt to enter login information to the hubmap Pypi account will appear\n\n### Files\n\nThis code contains:\n\n**\\_\\_main\\_\\_.py**: Contains the implementation of the command-line interface as well as the logic for the clt.\n\nInside of **\\_\\_main\\_\\_.py** are the following classes:\n\n* whoami: Informs the user if they are logged into Globus\n* login: Initiates a Globus login using the default web browser\n* transfer: Sets up a transfer into the user's downloads file. Accepts a single required argument. This argument is the name of a manifest file which contains information on the files to be downloaded\n* batch_transfer: Calls globus batch transfer for each source collection represented in the manifest file. \n\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A command line interface to download multiple files and directories from Globus file transfer service using a manifest file.",
"version": "1.1.3",
"split_keywords": [
"hubmap clt",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2de393c48433ab1a81af4e6eb0d170e0a2e517f93bc1078cc029946cb6bc32a",
"md5": "1af6250f35dfbba42a79beb77ed01857",
"sha256": "8f6d18b30b228dbd2eab3d344582ee56ba9d98eb7cd588f3d8dbc59a0e9d09f7"
},
"downloads": -1,
"filename": "hubmap_clt-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1af6250f35dfbba42a79beb77ed01857",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8500,
"upload_time": "2023-04-07T17:23:35",
"upload_time_iso_8601": "2023-04-07T17:23:35.809343Z",
"url": "https://files.pythonhosted.org/packages/b2/de/393c48433ab1a81af4e6eb0d170e0a2e517f93bc1078cc029946cb6bc32a/hubmap_clt-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00b62881105ca0d7f7e392d90e627c60055b23a080657176bd6da8fe277f1d35",
"md5": "510cf509f9e8523436f122b2ffd7fd97",
"sha256": "752368c77c6c84ab08a5d97f05fd5f566d90bf9390cb220893c76daf805fd647"
},
"downloads": -1,
"filename": "hubmap-clt-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "510cf509f9e8523436f122b2ffd7fd97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7135,
"upload_time": "2023-04-07T17:23:37",
"upload_time_iso_8601": "2023-04-07T17:23:37.891571Z",
"url": "https://files.pythonhosted.org/packages/00/b6/2881105ca0d7f7e392d90e627c60055b23a080657176bd6da8fe277f1d35/hubmap-clt-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 17:23:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "hubmap-clt"
}
