Skip to main content

GBDX Cloud Harness

Project description

https://badge.fury.io/py/gbdx-cloud-harness.svg Documentation Status Stories in Ready https://codecov.io/gh/TDG-Platform/cloud-harness/branch/master/graph/badge.svg

This package allows a user to build custom GBDX tasks that can be executed locally and also remotely on the platform. All from a python file and commandline tools.

To run remote tasks, this package uses the gbdx-auth package. Therefore the users credentials must be configured according to gbdx-auth.

Installation

To install from pypi:

pip install gbdx-cloud-harness

Usage

The cloud-harness package has a template task with example usage inside. To create a new template:

cloud-harness create my_app cd my_app/

In the new folder, there will be a app.py file which is the template. Open in your favorite editor to start building a new task. When ready to run the task:

cloud-harness run app.py

Please note, to run the task locally, all port values must be valid filesystem locations. Otherwise errors will be raised.

When the task is ready to be ran on the platform, use the –remote flag:

cloud-harness run app.py --remote

This will run the task on the platform assuming all the port values are S3 locations. Otherwise errors will be raised.

If there is local data that needs to be pushed to S3 for the remote run, then the –upload flag needs to be used:

cloud-harness run app.py --remote --upload

This will push all local data the ports contain to the users account storage, prior to executing the workflow.

Development

Contributing

Please contribute! Please make pull requests directly to master. Before making a pull request, please:

  • Ensure that all new functionality is covered by unit tests.
  • Verify that all unit tests are passing.
  • Ensure that all functionality is properly documented.t
  • Ensure that all functions/classes have proper docstrings so sphinx can autogenerate documentation.
  • Fix all versions in setup.py (and requirements.txt)

Run Tests

Tests use pytest framework

py.test [...]
python -m pytest [...]

Create a new version

To create a new version:

bumpversion ( major | minor | patch )
git push --tags

Don’t forget to update the changelog and upload to pypi.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
gbdx-cloud-harness-0.2.25.tar.gz (51.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page