{ "info": { "author": "Gerard Devine, Dan Metzen", "author_email": "gerarddevine@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "\n# HIEvPy\nHIEvPy is a python 3 wrapper around the API interface of the [HIEv](https://hiev.westernsydney.edu.au), a data capture \napplication used by the [Hawkesbury Institute for the Environment](https://www.westernsydney.edu.au/hie) at [Western \nSydney University](https://westernsydney.edu.au). \n\nA short overview of the HIEvPy library, including installation instructions, is given below. Full \ndocumentation, with examples, can be found on the project's [documentation pages](https://gdevine.github.io/hievpy).\n\n\n\n### Pre-requisites\nTo use HIEvPY you must have an active account (and subsequently a HIEv API token) on the \n[**HIEv**](https://hiev.westernsydney.edu.au) application. To discuss registration please contact HIE's data manager, \n[Gerry Devine](mailto:g.devine@westernsydney.edu.au)\n\n\n### Installation\n**HIEvPy** can be installed via *pip*:\n\n``` bash\n$ pip install --index-url https://test.pypi.org/simple/ hievpy\n```\n\n> Note: HIEvPy is currently hosted on Test PyPi. This will soon be moved to the official PyPi repository\n\nOnce **HIEvPy** has been installed, you can import it into a python console or script using:\n\n``` python\nimport hievpy as hp\n```\n(using the optional *as hp* as a shortcut)\n\n### HIEvPy functions\n\n##### Generic functions\n- **search**: Return a list of HIEv records matching a set of input search parameters\n- **search_download**: Perform a hievpy search and automatically downloads the matching files\n- **upload**: Upload a file to HIEv with associated metadata\n- **update_metadata**: Update metadata on a list of records returned by hievpy search\n\n##### TOA5 functions\n- **toa5_summary**: Returns toa5 summary information (variable names, units and measurement types) for a given\n individual search-returned record.\n- **search_loaf_toa5df**: Performs a hievpy search and loads results into a pandas dataframe given the file records\n\nSee the project's [documentation pages](https://gdevine.github.io/hievpy) for a full explanation of all **HIEvPy** functions\n\n### Examples\nThe __examples__ folder contains a number of example scripts outlining usage of the different **HIEvPy** functions. \n\nTo 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\n\n import hievpy as hp\n hp.utils.make_credsfile()\n\n\n### License\nCopyright (c) 2018 Gerry Devine\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gdevine/hievpy", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "hievpy", "package_url": "https://pypi.org/project/hievpy/", "platform": "", "project_url": "https://pypi.org/project/hievpy/", "project_urls": { "Homepage": "https://github.com/gdevine/hievpy" }, "release_url": "https://pypi.org/project/hievpy/1.2.0/", "requires_dist": [ "pandas", "tqdm", "requests", "certifi" ], "requires_python": "", "summary": "Python 3 wrapper for the HIEv Data Capture Application API", "version": "1.2.0" }, "last_serial": 5611749, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "2ded73563a493c6643353b544e68c8fb", "sha256": "15d7957e0b018be11693d82d61b9ca1169a725883402c7eefc604b3e0aae3eb8" }, "downloads": -1, "filename": "hievpy-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "2ded73563a493c6643353b544e68c8fb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6288, "upload_time": "2019-06-19T03:55:52", "url": "https://files.pythonhosted.org/packages/9e/c7/2c986305b55e957766321104e63d8d32add4a6e03e44313e7314cd8df3d4/hievpy-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "049e550ff7a5c26d46ecf09a9f7c3505", "sha256": "66c3f62d3429e78396dbc2a6c47688c3b6ddf8b20dc9f50f8cdbceedb33147e1" }, "downloads": -1, "filename": "hievpy-0.2.tar.gz", "has_sig": false, "md5_digest": "049e550ff7a5c26d46ecf09a9f7c3505", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5862, "upload_time": "2019-06-19T03:56:04", "url": "https://files.pythonhosted.org/packages/5f/78/831985d08ac6f5d311d1b9077f53d8d20691b88dc2a653ac76ef30a376d8/hievpy-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "f111cf790684b4a55e9f32c4d5b21a1c", "sha256": "77b67492c169b063c38c41960108e699dbba0ae91d9728d4e3a3cc17baf26eb8" }, "downloads": -1, "filename": "hievpy-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "f111cf790684b4a55e9f32c4d5b21a1c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5540, "upload_time": "2019-06-19T03:55:53", "url": "https://files.pythonhosted.org/packages/d4/43/927e716eb0dece606c369b5df98910e7095df0505600cd2b6b0a577012bd/hievpy-0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da576322376336df3fc60ef4a56a04c1", "sha256": "59b16877d3c34a707e885090ca006928176801823a78954bc52884ce1836be23" }, "downloads": -1, "filename": "hievpy-0.3.tar.gz", "has_sig": false, "md5_digest": "da576322376336df3fc60ef4a56a04c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4192, "upload_time": "2019-06-19T03:56:08", "url": "https://files.pythonhosted.org/packages/de/aa/0ab7fa966e5f138dfe6a49047f69eb6d75c064ead12c0109b1f27f51cf2d/hievpy-0.3.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "484cd14b25deed838d2c82470b8a5281", "sha256": "865fc8fdaf88807082e595fcfed6a1ecea132a48ba7a6419e1a8b32c0eeb7fb0" }, "downloads": -1, "filename": "hievpy-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "484cd14b25deed838d2c82470b8a5281", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5558, "upload_time": "2019-06-19T03:55:55", "url": "https://files.pythonhosted.org/packages/67/79/3cce0d0b25f6bea38095ceb3d0150a3a62ff169214b1a27a867d0fdcdeba/hievpy-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76e8c01f9b3220ef29585aee3a9ac2ab", "sha256": "b3729abb5a2d6eff665130565853d28c20520e8b16b0432301262e322ca55a5c" }, "downloads": -1, "filename": "hievpy-0.3.1.tar.gz", "has_sig": false, "md5_digest": "76e8c01f9b3220ef29585aee3a9ac2ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4190, "upload_time": "2019-06-19T03:56:05", "url": "https://files.pythonhosted.org/packages/96/d4/ad8d7e21253883ba3ee69211dee5197de1b7a9cd8b43dcf92ac06335765c/hievpy-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "6ad5519a66554411da6c3b3f1c371aaf", "sha256": "83cc4aa63d3071a9dba89a8fad0f474a8c1756fb25aed309e7704d9092810e28" }, "downloads": -1, "filename": "hievpy-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "6ad5519a66554411da6c3b3f1c371aaf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5559, "upload_time": "2019-06-19T03:55:57", "url": "https://files.pythonhosted.org/packages/90/93/61660caecbff8695e568529cd12c102524afa0bf8ab411e2758beb8f3388/hievpy-0.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c66f7faf4bb9f536e6fc076c83fc6bf9", "sha256": "8e0e808c40d0fb5ab7b41f05d73f7a24be339d85656771e34d4ba400b1b48d9e" }, "downloads": -1, "filename": "hievpy-0.3.2.tar.gz", "has_sig": false, "md5_digest": "c66f7faf4bb9f536e6fc076c83fc6bf9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4196, "upload_time": "2019-06-19T03:56:06", "url": "https://files.pythonhosted.org/packages/20/6a/cce51701ed5c372353ad2880e1deb4505f73819639fc212f4f1f4112e05e/hievpy-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "2e287ce7ec867eb84bf61ea46b8a117f", "sha256": "2a75d564c049d1940c30ff5b70f649e643127a58043be8e493ffb887725ea043" }, "downloads": -1, "filename": "hievpy-0.4.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2e287ce7ec867eb84bf61ea46b8a117f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7428, "upload_time": "2019-06-19T03:55:58", "url": "https://files.pythonhosted.org/packages/86/79/e4485ec020d9f1079f7f2fb407265b08223e6c9d6874e5a7a04fccf40324/hievpy-0.4.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73cfc2061ac8f0df893c1897bdc27e1c", "sha256": "fd983ea9f19a19ec89b595c9336d9d0e2389148f9d35a9e1420de56c62967416" }, "downloads": -1, "filename": "hievpy-0.4.0.tar.gz", "has_sig": false, "md5_digest": "73cfc2061ac8f0df893c1897bdc27e1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6113, "upload_time": "2019-06-19T03:56:09", "url": "https://files.pythonhosted.org/packages/5a/40/6414d4dbd6c72b0f4e7188e5498aa3a68aea41db93f3a8c411a617a76091/hievpy-0.4.0.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "d37b972a81b7222a040c9f088e28ac46", "sha256": "dcbc937ca3e788a641bfede6a49198c933dadf2ae162d3d43a03d56b8ece5661" }, "downloads": -1, "filename": "hievpy-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d37b972a81b7222a040c9f088e28ac46", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7428, "upload_time": "2018-11-05T04:11:24", "url": "https://files.pythonhosted.org/packages/ff/48/f945b8b7ee03ede5eacea9d7dea379e4e39ddc1d34484baf62ed98b1b0d5/hievpy-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "079e510b6424abc574470bd597d4c979", "sha256": "151ebdd18fc2404db706aac8060b37fb268178351452610b395bb8d3efdb78f1" }, "downloads": -1, "filename": "hievpy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "079e510b6424abc574470bd597d4c979", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6129, "upload_time": "2018-11-05T04:11:25", "url": "https://files.pythonhosted.org/packages/b2/dd/cd1e5fc575588aaabd04c31902b82710c0b704c93c711df65c691f4cd376/hievpy-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "8b0b4c15406889c079b87161702529ce", "sha256": "8ea417a5973e39ed524c32ab93fb27faa612e8cfa72271185824108692908d7a" }, "downloads": -1, "filename": "hievpy-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8b0b4c15406889c079b87161702529ce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7708, "upload_time": "2019-06-19T03:56:00", "url": "https://files.pythonhosted.org/packages/43/8f/97d881fbe82048920452c28d4c771ea80b4fb9c003c0fc209b35647b9967/hievpy-1.1.0-py3-none-any.whl" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "eb8b42198291e345ef780ac4810530ee", "sha256": "a4df90ff92975614fa389469aafae704c0c5e23ab1063e5d7e94143c0bd6c2ac" }, "downloads": -1, "filename": "hievpy-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eb8b42198291e345ef780ac4810530ee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7712, "upload_time": "2019-07-31T06:22:03", "url": "https://files.pythonhosted.org/packages/55/a1/d4ddfad960de814073c106b9814b6a8246ccb443f81d08323e3f5c7eb11b/hievpy-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "198ec5b4d6475e69a850ce63e24ad5c5", "sha256": "0300dc9157f0906e3412d906f4bb1ecd8e37f437694873379abb334f23fc7ea2" }, "downloads": -1, "filename": "hievpy-1.2.0.tar.gz", "has_sig": false, "md5_digest": "198ec5b4d6475e69a850ce63e24ad5c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6393, "upload_time": "2019-07-31T06:22:05", "url": "https://files.pythonhosted.org/packages/74/5c/233b485a245eb757948a4edfc3df4a64d9cd48a8021bebb87c1dee57eaaf/hievpy-1.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "eb8b42198291e345ef780ac4810530ee", "sha256": "a4df90ff92975614fa389469aafae704c0c5e23ab1063e5d7e94143c0bd6c2ac" }, "downloads": -1, "filename": "hievpy-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eb8b42198291e345ef780ac4810530ee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7712, "upload_time": "2019-07-31T06:22:03", "url": "https://files.pythonhosted.org/packages/55/a1/d4ddfad960de814073c106b9814b6a8246ccb443f81d08323e3f5c7eb11b/hievpy-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "198ec5b4d6475e69a850ce63e24ad5c5", "sha256": "0300dc9157f0906e3412d906f4bb1ecd8e37f437694873379abb334f23fc7ea2" }, "downloads": -1, "filename": "hievpy-1.2.0.tar.gz", "has_sig": false, "md5_digest": "198ec5b4d6475e69a850ce63e24ad5c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6393, "upload_time": "2019-07-31T06:22:05", "url": "https://files.pythonhosted.org/packages/74/5c/233b485a245eb757948a4edfc3df4a64d9cd48a8021bebb87c1dee57eaaf/hievpy-1.2.0.tar.gz" } ] }