Skip to main content

Turns DLHub metadata into functional Python objects

Project description

# DLHub home_run

[![Build Status](https://travis-ci.org/DLHub-Argonne/home_run.svg?branch=master)](https://travis-ci.org/DLHub-Argonne/home_run) [![Coverage Status](https://coveralls.io/repos/github/DLHub-Argonne/home_run/badge.svg?branch=master)](https://coveralls.io/github/DLHub-Argonne/home_run?branch=master) [![PyPI version](https://badge.fury.io/py/home-run.svg)](https://badge.fury.io/py/home-run)

home_run is a tool used by [the Data and Learning Hub for Science](https://www.dlhub.org) internally to turn a bunch of files and a recipe into an functional Python object.

## Installation

home_run is on PyPi. Install it by calling

`bash pip install home_run `

home_run is designed to be as light-weight as possible, and has only requests as a dependency.

## Technical Details

The key ingredients for using home_run are files describing a function that will be served by DLHub. These include a metadata file describing the servable (see [dlhub_sdk](http://github.com/dlhub-argonne/dlhub_sdk) for tools for creating these files, and [dlhub_schemas](http://github.com/dlhub-argonne/dlhub_schemas) for the schemas), and the actual files that make up the servable (e.g., a Keras hdf5 file).

Each particular type of servable has its own recipe for going from these files to a Python object. All recipes are a subclass of BaseServable, which provides the general framework for defining a servable object. Each subclass has a matching BaseMetadataModel class in dlhub_sdk. For example, the type of servable that can be described by the PythonStaticMethodModel can be run by the PythonStaticMethodServable.

## Project Support This material is based upon work supported by Laboratory Directed Research and Development (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357.

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

home_run-0.4.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

home_run-0.4.0-py2.py3-none-any.whl (12.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file home_run-0.4.0.tar.gz.

File metadata

  • Download URL: home_run-0.4.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for home_run-0.4.0.tar.gz
Algorithm Hash digest
SHA256 31d5ab4e15763c86ec9d9d18c2e9e712518bd6b9e24c5b2a1dfdf8cbdb804d8d
MD5 acc0f3795d3bc5eec861c787362e96ac
BLAKE2b-256 6c85710992411cf0643af59237ad87f7ddd13f344ac10f9b76e66a18a4ec7d55

See more details on using hashes here.

File details

Details for the file home_run-0.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: home_run-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for home_run-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 24450fd325d1a1056c5ac9898fba550e94058debd1c5bd371ac54b656c4ba821
MD5 1280b3fdb33fba644a7e365bc8223656
BLAKE2b-256 95626d9352d3d8bce73b8c0b330b05080a290159cbb5ce8c78c6c24280a004e1

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