{ "info": { "author": "Anders G. Eriksen", "author_email": "anders.eriksen@bt.no", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# frost-client\n\n[![Build Status](https://travis-ci.org/BergensTidende/frost-client.svg?branch=master)](https://travis-ci.org/BergensTidende/frost-client)\n\n[![Documentation Status](https://readthedocs.org/projects/frost-client/badge/?version=latest)](https://frost-client.readthedocs.io/en/latest/?badge=latest)\n\nThis Python client wraps the [Frost API](https://frost.met.no/concepts#getting_started). You should \nread up on those docs before using this client. And be sure to check out met.no's \n[Terms of Use](https://frost.met.no/termsofuse)\n\nThe main purpose of this client is returns Pandas Dataframes from Frost API data.\n\nThis is an unofficial client. We have no relationship to met.no\n\nDocumentation: https://frost-client.readthedocs.io/en/latest/\n\n## Install\n\nRequires Python 3.7\n\n`pip install frost-client`\n\nor\n\n`pipenv install frost-client`\n\nThis will install the frost-client and Pandas.\n\n## Usage\n\nThe Frost API key should be exposed as a environment variable:\n\n`FROST_API_KEY=xxxxxx` \n\nor passed as a username parameter when creating and instance of the class.\n\n### Get weather data sources\n\nGet all available observation sources (stations) for Hordaland county (12)\n\n```\nfrom frost.client import APIError, Frost\nf = Frost()\nres = f.get_sources(county='12')\n\n# return as Pandas Dataframe\ndf = res.to_df()\n\n# return IDs of sources as list\nids = res.to_ids_list()\n```\n\n### Get available time series\n\nDisplay available time series for a station (here Bergen - Florida)\n\n```\nfrom frost.client import APIError, Frost\nf = Frost()\nres = f.get_available_timeseries(sources=['SN50540'])\n\n# return as Pandas Dataframe\ndf = res.to_df()\n\n```\n\n### Get observations\n\nDisplay observations for a station (here Bergen - Florida)\n\n```\nfrom frost.client import APIError, Frost\nf = Frost()\nres = f.get_observations(\n sources=['SN50540'],\n elements=['sum(precipitation_amount P1D)'],\n timeoffsets=['PT6H'],\n referencetime='2018-01-01/2018-02-01')\ndf = res.to_df()\n\n```\n\nSee tests for more examples.\n\n## Local development\n\nYou should use pipenv\n\n### Tests\n\nEnable the pipenv with\n\n`pipenv shell`\n\nMake sure to export env variable \n\n`FROST_API_KEY=xxxxxx`\n\nTo run all tests: \n\n`nosetests`\n\nTo run specific tests:\n\n`nosetests tests.test_requests:TestFrostRequests.test_get_sources`\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/BergensTidende/frost-client", "keywords": "weather pandas", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "frost-client", "package_url": "https://pypi.org/project/frost-client/", "platform": "", "project_url": "https://pypi.org/project/frost-client/", "project_urls": { "Homepage": "https://github.com/BergensTidende/frost-client" }, "release_url": "https://pypi.org/project/frost-client/0.1.3/", "requires_dist": [ "requests", "pandas" ], "requires_python": ">= 3.6", "summary": "Python wrapper for the frost.met.no API", "version": "0.1.3" }, "last_serial": 5328768, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "cf69129e21ad56f79c9b67f4e9ffbe42", "sha256": "b40a9a393fac2f5de844ef1e535954281eca4fa1157b583759084cced2d159b6" }, "downloads": -1, "filename": "frost_client-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "cf69129e21ad56f79c9b67f4e9ffbe42", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9260, "upload_time": "2018-10-10T12:41:13", "url": "https://files.pythonhosted.org/packages/30/73/1b2d62192ca1b857f2852f5f8b138790cc5ddf966d67a0bda05f17626c20/frost_client-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4a4fac00355b63df675a52b22c2c5dc9", "sha256": "bc3718a26a98e1810c1d6614dedeb107d26cecd7cccc31ff62fa1fcd8584458a" }, "downloads": -1, "filename": "frost-client-0.1.tar.gz", "has_sig": false, "md5_digest": "4a4fac00355b63df675a52b22c2c5dc9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6887, "upload_time": "2018-10-10T12:41:17", "url": "https://files.pythonhosted.org/packages/f0/34/36942ea6b1f028bbc23711bbf1d737d2a53c62b1d95831e92d1533d2e44f/frost-client-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "8419ece2f62fa4aee689cec2a45134f3", "sha256": "d012f1e4a093cb8913f5e4a7d678524a99a55c3276ab77ee9d6aa7647756b02a" }, "downloads": -1, "filename": "frost_client-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8419ece2f62fa4aee689cec2a45134f3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10136, "upload_time": "2018-10-10T12:41:15", "url": "https://files.pythonhosted.org/packages/45/96/97801a436ec296f3c8ddef6a651cbbfb92add028e1e19cde1b3893230f38/frost_client-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "049cac766aecf364d72870ad0dbc1ce0", "sha256": "22ebf18e4ecdbf19990a814c21ab67d2fb082366465ab5a6524626429f408201" }, "downloads": -1, "filename": "frost-client-0.1.1.tar.gz", "has_sig": false, "md5_digest": "049cac766aecf364d72870ad0dbc1ce0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6981, "upload_time": "2018-10-10T12:41:16", "url": "https://files.pythonhosted.org/packages/3d/78/b3192ee0bbc63ffddc109223526bd8f4703de041ff28cebef3f9c1dbb1e5/frost-client-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "5f41ff5af8dd9e77720f131a7cf312e4", "sha256": "4b9f60c04fe9a268c67deb7091628035329bb5ae4c9274550c7368f111af639c" }, "downloads": -1, "filename": "frost_client-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5f41ff5af8dd9e77720f131a7cf312e4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10123, "upload_time": "2018-10-10T12:44:52", "url": "https://files.pythonhosted.org/packages/5d/6d/e6a61bdbb72079d234ee81aa1f5f71996e1e22ba0dc884a1c59801890cae/frost_client-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "29e61abe0646d5b150f34043e31caa94", "sha256": "da9f07c84539097038f222ae73a9a5d9a0417ca4ca81dfc4418855e294207ee3" }, "downloads": -1, "filename": "frost-client-0.1.2.tar.gz", "has_sig": false, "md5_digest": "29e61abe0646d5b150f34043e31caa94", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7051, "upload_time": "2018-10-10T12:44:54", "url": "https://files.pythonhosted.org/packages/c2/81/0b62ae91ca5485a1ebda3afd848fd8210cbc52eef26c260e775c7b76c4d4/frost-client-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "ea309a23731ae725b0a7886b23bd4968", "sha256": "d78c84c3af31515699cc0807f4fca7d7e9a6db76de8d4a21740d4cd27bb28d47" }, "downloads": -1, "filename": "frost_client-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "ea309a23731ae725b0a7886b23bd4968", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">= 3.6", "size": 10500, "upload_time": "2019-05-28T20:10:31", "url": "https://files.pythonhosted.org/packages/61/9c/566a389bcc7fdb4f8ee0dcbe5747c7572c3438f8b650c649efb8857cad95/frost_client-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53cf6ab4255216ce41a97d620d5e0db4", "sha256": "5d8b7ca4b207ec78d4634618dd53e697e2465ec9f0998f87505440874eced665" }, "downloads": -1, "filename": "frost-client-0.1.3.tar.gz", "has_sig": false, "md5_digest": "53cf6ab4255216ce41a97d620d5e0db4", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.6", "size": 7807, "upload_time": "2019-05-28T20:10:32", "url": "https://files.pythonhosted.org/packages/11/8a/1e54d544ea7ab577f67f225183fe9c72be1afb132b91df4e9cef36b265f9/frost-client-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ea309a23731ae725b0a7886b23bd4968", "sha256": "d78c84c3af31515699cc0807f4fca7d7e9a6db76de8d4a21740d4cd27bb28d47" }, "downloads": -1, "filename": "frost_client-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "ea309a23731ae725b0a7886b23bd4968", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">= 3.6", "size": 10500, "upload_time": "2019-05-28T20:10:31", "url": "https://files.pythonhosted.org/packages/61/9c/566a389bcc7fdb4f8ee0dcbe5747c7572c3438f8b650c649efb8857cad95/frost_client-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53cf6ab4255216ce41a97d620d5e0db4", "sha256": "5d8b7ca4b207ec78d4634618dd53e697e2465ec9f0998f87505440874eced665" }, "downloads": -1, "filename": "frost-client-0.1.3.tar.gz", "has_sig": false, "md5_digest": "53cf6ab4255216ce41a97d620d5e0db4", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.6", "size": 7807, "upload_time": "2019-05-28T20:10:32", "url": "https://files.pythonhosted.org/packages/11/8a/1e54d544ea7ab577f67f225183fe9c72be1afb132b91df4e9cef36b265f9/frost-client-0.1.3.tar.gz" } ] }