{ "info": { "author": "Antonis Christofides", "author_email": "antonis@antonischristofides.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "===================\nenhydris-api-client\n===================\n\n\n.. image:: https://img.shields.io/pypi/v/enhydris_api_client.svg\n :target: https://pypi.python.org/pypi/enhydris-api-client\n :alt: Pypi\n\n.. image:: https://img.shields.io/travis/openmeteo/enhydris-api-client.svg\n :target: https://travis-ci.org/openmeteo/enhydris-api-client\n :alt: Build\n\n.. image:: https://codecov.io/github/openmeteo/enhydris-api-client/coverage.svg\n :target: https://codecov.io/gh/openmeteo/enhydris-api-client\n :alt: Coverage\n\n.. image:: https://pyup.io/repos/github/openmeteo/enhydris-api-client/shield.svg\n :target: https://pyup.io/repos/github/openmeteo/enhydris-api-client/\n :alt: Updates\n\nPython API client for Enhydris\n\n* Free software: GNU General Public License v3\n\nThis package has some functionality to make it easier to use the\nEnhydris API.\n\nInstallation\n============\n\n``pip install enhydris-api-client``\n\nExample\n=======\n\n::\n\n from enhydris_api_client import EnhydrisApiClient\n\n with EnhydrisApiClient(\"https://openmeteo.org\") as api_client:\n api_client.login(\"joe\", \"topsecret\")\n\n # Get a dict with attrs of station with id=42\n station = api_client.get_model(Station, 42)\n\n # Create a new station\n api_client.post_model(Station, data={\"name\": \"my station\"})\n\n\nReference\n=========\n\n**EnhydrisApiClient(base_url)**\n\nCreates and returns an api client. It can also be used as a context\nmanager, though this is not necessary. If not used as a context manager,\nyou might get warnings about unclosed sockets.\n\n``EnhydrisApiClient`` objects have the following methods:\n\n**.login(username, password)**\n\nLogins to Enhydris. Raises an exception if unsuccessful.\n\n**.get_station(id)**\n\nReturns a dict with the data for the station with the given ``id``.\n\n**.post_station(data)**\n\nCreates a new station, with its data given by dictionary ``data``, and\nreturns its id.\n\n**.put_station(station_id, data)**\n\nReplaces the station's attributes with ``data`` (a dictionary). Any\nunspecified attributes are set to null.\n\n**.patch_station(station_id, data)**\n\nSame as ``put_station()`` except that any attribute not specified in\n``data`` is untouched.\n\n**.delete_station(station_id)**\n\nDeletes the specified station.\n\n**.get_timeseries(station_id, timeseries_id)**\n\nReturns a dict with the data for the given time series.\n\n**.post_timeseries(station_id, data)**\n\nCreates a new time series, with its data given by dictionary ``data``,\nand returns its id.\n\n**.delete_timeseries(station_id, timeseries_id)**\n\nDeletes the specified time series.\n\n**.read_tsdata(station_id, timeseries_id, start_date=None, end_date=None)**\n\nRetrieves the time series data into a htimeseries object that it\nreturns. If ``start_date`` and/or ``end_date`` are specified, only the\npart of the time series between these dates is retrieved.\n\n**.post_tsdata(station_id, timeseries_id, ts)**\n\nPosts a time series to Enhydris, appending the records to any already\nexisting. ``ts`` is a htimeseries object.\n\n**.get_ts_end_date(station_id, timeseries_id)**\n\nReturns a ``datetime`` object which is the last timestamp of the time\nseries. If the time series is empty it returns ``None``.\n\n\n=======\nHistory\n=======\n\n0.5.0 (2019-06-13)\n==================\n\n- Can now be used as a context manager\n- Added post/put/patch/delete station\n\n0.4.1 (2019-06-12)\n==================\n\n- Fixed bug where .read_tsdata() was failing to set the metadata\n attributes of the time series.\n\n0.4.0 (2019-06-12)\n==================\n\n- .read_tsdata() now accepts optional arguments start_date and end_date.\n\n0.3.0 (2019-06-06)\n==================\n\n- Upgrade dependecy htimeseries to 1.0\n\n0.2.0 (2019-04-17)\n==================\n\n- Support new API of Enhydris 3\n\n0.1.0 (2019-03-06)\n==================\n\n- Initial release\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/openmeteo/enhydris-api-client", "keywords": "", "license": "GNU General Public License v3", "maintainer": "", "maintainer_email": "", "name": "enhydris-api-client", "package_url": "https://pypi.org/project/enhydris-api-client/", "platform": "", "project_url": "https://pypi.org/project/enhydris-api-client/", "project_urls": { "Homepage": "https://github.com/openmeteo/enhydris-api-client" }, "release_url": "https://pypi.org/project/enhydris-api-client/0.5.0/", "requires_dist": [ "iso8601", "pandas (>=0.20)", "requests (<3,>=1)", "htimeseries (<2,>=1.1.1)" ], "requires_python": "", "summary": "Python API client for Enhydris", "version": "0.5.0" }, "last_serial": 5395295, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "14cd2b39484dbba0692ed48c097d3b41", "sha256": "e54474f898e06f83e214619cbe9e52ad3eef77c5ba6fcf6f4a9a22624c3bd588" }, "downloads": -1, "filename": "enhydris_api_client-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "14cd2b39484dbba0692ed48c097d3b41", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4327, "upload_time": "2019-03-06T09:46:54", "url": "https://files.pythonhosted.org/packages/aa/57/e3546850a576c34f07660b3d27e66b5a14854e881942d18e5b153224f898/enhydris_api_client-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f1d44742ee217f5b7664280a8df58786", "sha256": "8b4d8a0c9d1ff7f9a07db14c903a7c79bf8832c97e7ce31ab6119034dc2e8c64" }, "downloads": -1, "filename": "enhydris-api-client-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f1d44742ee217f5b7664280a8df58786", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6939, "upload_time": "2019-03-06T09:46:56", "url": "https://files.pythonhosted.org/packages/7b/f7/155172c1bad70567f07742e0e22882e7125e24fcbd7d85d26a53b763df4e/enhydris-api-client-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "1e598a92b784137f85af63257f5847fe", "sha256": "04dab7488236b6459a97ae5160dfcf293aba1667a38b7c52713bb082b12c9d9c" }, "downloads": -1, "filename": "enhydris_api_client-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1e598a92b784137f85af63257f5847fe", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4082, "upload_time": "2019-04-17T09:29:34", "url": "https://files.pythonhosted.org/packages/23/ae/328e54856f13b1923fadc16c94e416f940ff2581754d004e718f50e6225d/enhydris_api_client-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c993938752d16a53cd1d77a0b2a4b2e6", "sha256": "d0dfc5bc34fe4305c170bea152b90bacbb880b21040e352f4a92ca89a5aaeb4b" }, "downloads": -1, "filename": "enhydris-api-client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "c993938752d16a53cd1d77a0b2a4b2e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6691, "upload_time": "2019-04-17T09:29:36", "url": "https://files.pythonhosted.org/packages/28/10/f4ba5a666366743da393bd351bf548b9835936bad6be32225cc7b1b5b208/enhydris-api-client-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "d3016a168adab842cef74f9c7f05918a", "sha256": "2034b00cb646859977ed2a4a3646d084f98beaa95a3673b535b2e3ef8d4daa0e" }, "downloads": -1, "filename": "enhydris_api_client-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d3016a168adab842cef74f9c7f05918a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4132, "upload_time": "2019-06-06T19:36:33", "url": "https://files.pythonhosted.org/packages/7f/0b/aa116179450131fbb80e2a2c6a67bff6099719d336e0594a654a397b4561/enhydris_api_client-0.3.0-py2.py3-none-any.whl" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "f4a23ba0a57700bfa574ba273858f63d", "sha256": "6ea60f45e572437276dbcc23c50242716d507a739c2d6d4c07f667a951f810eb" }, "downloads": -1, "filename": "enhydris_api_client-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f4a23ba0a57700bfa574ba273858f63d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4305, "upload_time": "2019-06-12T11:15:08", "url": "https://files.pythonhosted.org/packages/ca/20/d758627d78e369612ac8490473cb3315e38c279574f4b3be9aceeabab311/enhydris_api_client-0.4.0-py2.py3-none-any.whl" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "1f99783ce5a1e82ca1cf9141536adff9", "sha256": "9bf8061255a4ed70ac2e1e7e3a03dd666f8e622258508afb0b6431690e225454" }, "downloads": -1, "filename": "enhydris_api_client-0.4.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1f99783ce5a1e82ca1cf9141536adff9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6680, "upload_time": "2019-06-12T11:55:43", "url": "https://files.pythonhosted.org/packages/0a/c1/54fda3e6418bba8d5d1326cf2666ac6d198e260f7e7af5bcc1af8e1687d9/enhydris_api_client-0.4.1-py2.py3-none-any.whl" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "81ddbfe0fc6a7d8f83c34ccd14ef594c", "sha256": "49eae5da1c6999136718719f24036f86abea2329fffaee5c44baea7e700ff62b" }, "downloads": -1, "filename": "enhydris_api_client-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "81ddbfe0fc6a7d8f83c34ccd14ef594c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4717, "upload_time": "2019-06-13T10:13:54", "url": "https://files.pythonhosted.org/packages/d9/0d/5086c16d8d67bea123258cac5498e245310077b950a503f567da29bf96c4/enhydris_api_client-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1d0aca9ce333d5f72024381281c99076", "sha256": "49ad501cac73cb7694dd2b57c3bab5cb49a7159cd847bbaad6bc0f569faf96a6" }, "downloads": -1, "filename": "enhydris-api-client-0.5.0.tar.gz", "has_sig": false, "md5_digest": "1d0aca9ce333d5f72024381281c99076", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8761, "upload_time": "2019-06-13T10:13:56", "url": "https://files.pythonhosted.org/packages/f4/a9/7317fb24770524b3548d17634d0fd4e23c468169735e1954bbc2dcc098d1/enhydris-api-client-0.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "81ddbfe0fc6a7d8f83c34ccd14ef594c", "sha256": "49eae5da1c6999136718719f24036f86abea2329fffaee5c44baea7e700ff62b" }, "downloads": -1, "filename": "enhydris_api_client-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "81ddbfe0fc6a7d8f83c34ccd14ef594c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4717, "upload_time": "2019-06-13T10:13:54", "url": "https://files.pythonhosted.org/packages/d9/0d/5086c16d8d67bea123258cac5498e245310077b950a503f567da29bf96c4/enhydris_api_client-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1d0aca9ce333d5f72024381281c99076", "sha256": "49ad501cac73cb7694dd2b57c3bab5cb49a7159cd847bbaad6bc0f569faf96a6" }, "downloads": -1, "filename": "enhydris-api-client-0.5.0.tar.gz", "has_sig": false, "md5_digest": "1d0aca9ce333d5f72024381281c99076", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8761, "upload_time": "2019-06-13T10:13:56", "url": "https://files.pythonhosted.org/packages/f4/a9/7317fb24770524b3548d17634d0fd4e23c468169735e1954bbc2dcc098d1/enhydris-api-client-0.5.0.tar.gz" } ] }