CFDE Submit
This is a client to interact with the Globus Automate Flows for CFDE use cases. Both a Python API and a CLI tool are available.
Installation
The CFDE Submission Client requires Python 3.6 or later. To check which version of Python you have, run python –version. If you have both Python 2 and Python 3 installed, you may need to check with python3 –version. If this is the case, you will also need to use pip3 instead of pip below.
Install with pip:
pip install cfde-submitUsage
This tool can ingest any of the following into DERIVA:
A directory to be formatted into a BDBag
A premade BDBag directory
A premade BDBag in an archive file
In all cases, the data must already be in CFDE TableSchema format, or the ingest may fail. See instructions here (link to docs pending).
Command line
There are four commands available: run, status, login, logout, and reset. Use them as follows:
cfde-submit run DATA-PATH will ingest the data found at DATA-PATH into CFDE. You can also specify the following options:
--output-dir=OUTPUT_DIR will copy the data in DATA-PATH, if it is a directory, to the location you specify, which must not exist and must not be inside DATA-PATH. The resulting BDBag will be named after the output directory. If not specified, the BDBag will be created in-place in DATA_PATH if necessary.
--delete-dir will trigger deletion of the output-dir after processing is complete. If you didn’t specify output-dir, this option has no effect.
--ignore-git will prevent the client from overwriting output-dir and delete-dir to handle Git repositories.
cfde-submit status will check the status of a Flow instance.
cfde-submit login will start the login process. If you have tokens saved from a previous login, this command will validate those tokens and only re-authenticate you if they are expired. It is not necessary to run this command before run or status, because those commands will also authenticate you if needed.
cfde-submit logout will log you out and revoke any valid cached tokens.
cfde-submit reset will reset your cfde-submit configuration.
Python API
The CfdeClient class, once instantiated, has the following methods:
start_deriva_flow(self, data_path, catalog_id=None, output_dir=None, delete_dir=False, **kwargs)
check_status(self, flow_id=None, flow_instance_id=None, raw=False)
logout(self)
The arguments operate in the same fashion as the CLI options, and are documented in detail in the method docstrings.
3 maintainers
Metadata
3 maintainers
Release files for cfde-submit 0.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cfde-submit-0.2.5.tar.gz | 33.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cfde_submit-0.2.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 59.2 kB
Release files / cfde-submit-0.2.5.tar.gz
| Download URL | cfde-submit-0.2.5.tar.gz |
|---|---|
| Size | 33.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe3b0e28cba40e2b5c95a41cc79701aca4bf4ad411d4178d98d63a09fa250b9f
|
|
BLAKE2b-256 checksum How to use checksums |
afd81dca8ecec99211d3ae3995064f6bf39a9535ba8ee194a7e952edd10809e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
|
Release files / cfde_submit-0.2.5-py3-none-any.whl
| Download URL | cfde_submit-0.2.5-py3-none-any.whl |
|---|---|
| Size | 25.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19a9bc548679a4628f0b671e015ce8f9820585badedff99405d2a66359a14b37
|
|
BLAKE2b-256 checksum How to use checksums |
d8fec31caf1fe4af7555c5ee4207423e34e7d93f0cb23bdf760868d1abe1b2fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
|
Security for cfde-submit 0.2.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
