Skip to main content

Portal CLI and API

Project description

Description

Dataerai is a federated scientific data management system developed by Oak Ridge National Laboratories to facilitate FAIR data practices within supported experimental, compute, and analytics environments. The Dataerai Python package provides both a command-line-interface (CLI) and a programming API for interacting with Dataerai services.

Developers

For running dataerai directly from the source folder located in the Dataerai GitHub repository, without running a pip install of the package. Activate the python env. This might be installed at /opt/dataerai/dependencies/python/bin if you used Dataerai's provided dependency install scripts with the default location.

source /opt/dataerai/dependencies/python/bin/activate

Run the following from the root of the Dataerai repo. The generate_dataerai script will generate default settings. the ENABLE_PYTHON_CLIENT is to make sure you actually build the python client. Many other default flags may be turned on, you can disable them if needed.

The build target will "pydataerai" is needed for compiling the protobuf files to python, you will need protobuf to be installed.

NOTE - You will need to rerun this command any times changes are made to the .proto files.

./scripts/generate_dataerai.sh
/opt/dataerai/dependencies/bin/cmake -S. -B build -DENABLE_PYTHON_CLIENT=ON
/opt/dataerai/dependencies/bin/cmake --build build --target pydataerai

Move into the python/dataerai_pkg folder and then you can execute the python cli tool directly with.

PYTHON_PATH=. ./scripts/dataerai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dataerai-0.1.0.tar.gz (49.0 kB view details)

Uploaded Source

File details

Details for the file dataerai-0.1.0.tar.gz.

File metadata

  • Download URL: dataerai-0.1.0.tar.gz
  • Upload date:
  • Size: 49.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for dataerai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cf18da097744a738164d1626dcd6894a17904833d37a619dff22d5a8ae8cd1fe
MD5 2a28909676a163cbf5cd3ebf26b656cd
BLAKE2b-256 14444a33a34da6ff49f5e7d48f9d1995ce9c11c1466709a2af9c2d894fa004d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page