HIEvPy

HIEvPy is a python 3 wrapper around the API interface of the HIEv, a data capture application used by the Hawkesbury Institute for the Environment at Western Sydney University.

A short overview of the HIEvPy library, including installation instructions, is given below. Full documentation, with examples, can be found on the project's documentation pages.

Pre-requisites

To use HIEvPY you must have an active account (and subsequently a HIEv API token) on the HIEv application. To discuss registration please contact HIE's data manager, Gerry Devine

Installation

HIEvPy can be installed via pip:

$ pip install --index-url https://test.pypi.org/simple/ hievpy

Note: HIEvPy is currently hosted on Test PyPi. This will soon be moved to the official PyPi repository

Once HIEvPy has been installed, you can import it into a python console or script using:

import hievpy as hp

(using the optional as hp as a shortcut)

HIEvPy functions

Generic functions

• search: Return a list of HIEv records matching a set of input search parameters
• search_download: Perform a hievpy search and automatically downloads the matching files
• upload: Upload a file to HIEv with associated metadata
• update_metadata: Update metadata on a list of records returned by hievpy search

TOA5 functions

• toa5_summary: Returns toa5 summary information (variable names, units and measurement types) for a given individual search-returned record.
• search_loaf_toa5df: Performs a hievpy search and loads results into a pandas dataframe given the file records

See the project's documentation pages for a full explanation of all HIEvPy functions

Examples

The examples folder contains a number of example scripts outlining usage of the different HIEvPy functions.

To run any of the example scripts you need to run hievpy.utils.make_credsfile() which creates a file github won't share called credentials.py and populates it with your HIEv API token

import hievpy as hp
hp.utils.make_credsfile()

License

Copyright (c) 2018 Gerry Devine

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.