Skip to main content

Python wrapper for the frost.met.no API

Project description

# frost-client

This Python client wraps the [Frost API](https://frost.met.no/concepts#getting_started). You should
read up on those docs before using this client. And be sure to check out met.no's
[Terms of Use](https://frost.met.no/termsofuse)

The main purpose of this client is returns Pandas Dataframes from Frost API data.

This is an unofficial client. We have no relationship to met.no

## Install

`pipenv install git+https://github.com/bergenstidende/frost-client.git@master#egg=frost-client`

This will install the frost-client and Pandas.

## Usage

The Frost API key should be exposed as a environment variable:

`FROST_API_KEY=xxxxxx`

or passed as a username parameter when creating and instance of the class.

### Get weather data sources

```
from client import APIError, Frost
f = Frost()
res = self.f.get_sources(county='12')

# return as Pandas Dataframe
df = res.to_df()

# return IDs of sources as list
ids = res.to_ids_list()
```

## Local development

You should use pipenv

### Tests

Enable the pipenv with

`pipenv shell`

Make sure to export env variable

`FROST_API_KEY=xxxxxx`

To run all tests:

`nosetests`

To run specific tests:

`nosetests tests.test_requests:TestFrostRequests.test_get_sources`


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frost-client-0.1.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

frost_client-0.1-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page