Python client to get emulation environment recommendations from the EaaSI UVI.
Project description
eaasi-uvi-client
About
Python client for getting emulation environment recommendations from the EaaSI software platform's Universal Virtual Interactor, or UVI.
Usage
Command-line interface
After installing package with pip
, use get-eaasi-recommendations
:
Usage: get-eaasi-recommendations [OPTIONS]
Get emulation environment suggestions from EaaSI API.
Options:
--eaasi-url TEXT EaaSI host URL. [required]
--data-url TEXT Data URL for content to characterize. [required]
--data-type TEXT Data type. Allowed values: "zip", "tar", "bagit+zip",
"bagit+tar" [default: zip]
--help Show this message and exit.
Python library
The eaasi_uvi_client
Python library consists mainly of the
EaaSIUVIClient
class, which has the following public methods:
EaaSIUVIClient.get_recommendations()
: returns dictionary representation of the JSON returned by EaaSI's EnvironmentProposer API endpoints; raisesrequests.ConnectionError
oreaasi_uvi_client.ResultNotFound
on error.EaaSIUVIClient.parse_suggested_environments()
: returns list of dictionaries with suggested emulation environments from JSON returned by EaaSI's EnvironmentProposer API endpoints; raiseseaasi_uvi_client.ResultNotFound
ifget_recommendations()
has not yet been called.
See cli/cli.py
for an implementation example.
Installation
Install eaasi_uvi_client package
eaasi-uvi-client
requires Python 3.6+.
Via PyPI
pip install eaasi-uvi-client
Manually
Download this repo:
git clone https://github.com/artefactual-labs/eaasi-uvi-client.git
Change into the cloned directory and install:
cd eaasi-uvi-client/
pip install .
Development
Installation
For development, it may be useful to install eaasi-uvi-client
with
pip install -e .
, which will apply changes made to the source code
immediately.
Publishing to PyPI
This repository contains a Makefile with commands to aid in building packages and publishing to [PyPI][pypi].
To check that the package is valid:
make package-check
To upload the package to PyPI (this requires PyPI credentials and being
listed as a collaborator on the auditmatica
project):
make package-upload
To clean up package distribution files:
make clean
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for eaasi_uvi_client-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aa2cd4de1920eee1a9879c8c034c018db61b768fc3c83773f6181a85dedc7dd |
|
MD5 | 233f54e9d12d2d3b658a46711f4dea8a |
|
BLAKE2b-256 | f7bead113579d18795c1f01d3716088a6cce7877454bcf2a642273cb3ed20356 |