neberheim / forecastiopy3

A Python wrapper for the forecast.io API.

ForcastIO Python 3

A Python wrapper for the Forecast.io API. This is a fork of David Ervideira's forecastiopy, ported for Python 3. If you are not using Python 3, make sure to use his version.

####Quick Start: Install the package:

python setup.py install

Get the coordinates of your location, let's say Lisbon:

>>> Lisbon = [38.7252993, -9.1500364]

Get the current temperature and precipitation probability:

>>> from forecastiopy import *
>>> fio = ForecastIO.ForecastIO(YOUR_APY_KEY, latitude=Lisbon[0], longitude=Lisbon[1])
>>> current = FIOCurrently.FIOCurrently(fio)
>>> print('Temperature:', current.temperature)
Temperature: 11.07
>>> print('Precipitation Probability:', current.precipProbability)
Precipitation Probability: 0.29

####What is does:

• It can read Data Points and Data blocks from the Forecast.io API.
  • This means it can read Currently, Minutely, Hourly, Daily, Flags and Alerts data.
• It reads all available fields.
• It reads all the available flags.
• It reads all the available alerts.
• It reads all the available errors.

####What it does not:

• It does not implements the callback request option.

####To Do:

• I'm not sure at this point in time but I'm sure something will appear.
• I need to improve the docstrings

####How it works: The forecastiopy package has 9 classes. The main class is ForecastIO: It handles the connection, build the url and the gets the initial data from the API. The classes FIOCurrently, FIOMinutely, FIOHourly, FIODaily, FIOFlags and FIOAlerts contain the currently, minutely, hourly, daily, flags and alerts reports. Data can be accessed by the returned dictionary or directly by attributes made with reflection magic. See "Usage Examples" below.

Please refer to the API docs https://developer.forecast.io for better understanding of the data and for the API key. - You'll need a key to get it to work.

####Dependencies:

• requests

Usage Examples

This instantiates the ForecastIO class

from forecastiopy import *

apikey = YOUR_APY_KEY

Lisbon = [38.7252993, -9.1500364]

fio = ForecastIO.ForecastIO(apikey,
                            units=ForecastIO.ForecastIO.UNITS_SI,
                            lang=ForecastIO.ForecastIO.LANG_ENGLISH,
                            latitude=Lisbon[0], longitude=Lisbon[1])

print('Latitude', fio.latitude, 'Longitude', fio.longitude)
print('Timezone', fio.timezone, 'Offset', fio.offset)
print(fio.get_url()) # You might want to see the request url

Get Currently weather data for the requested location

if fio.has_currently() is True:
	currently = FIOCurrently.FIOCurrently(fio)
	print('Currently')
	for item in currently.get().keys():
		print(item + ' : ' + unicode(currently.get()[item]))
	# Or access attributes directly
	print(currently.temperature)
	print(currently.humidity)
else:
	print('No Currently data')

Get Minutely weather data for the requested location

if fio.has_minutely() is True:
	minutely = FIOMinutely.FIOMinutely(fio)
	print('Minutely')
	print('Summary:', minutely.summary)
	print('Icon:', minutely.icon)

	for minute in xrange(0, minutely.minutes()):
		print('Minute', minute+1)
		for item in minutely.get_minute(minute).keys():
			print(item + ' : ' + unicode(minutely.get_minute(minute)[item]))

		# Or access attributes directly for a given minute.
		# minutely.minute_3_time would also work
		print(minutely.minute_1_time)
else:
	print('No Minutely data')

Get Hourly weather data for the requested location

if fio.has_hourly() is True:
	hourly = FIOHourly.FIOHourly(fio)
	print('Hourly')
	print('Summary:', hourly.summary)
	print('Icon:', hourly.icon)

	for hour in range(0, hourly.hours()):
		print('Hour', hour+1)
		for item in hourly.get_hour(hour).keys():
			print(item + ' : ' + str(hourly.get_hour(hour)[item]))
		# Or access attributes directly for a given minute.
		# hourly.hour_5_time would also work
		print(hourly.hour_3_time)
else:
	print('No Hourly data')

Get Daily weather data for the requested location

if fio.has_daily() is True:
	daily = FIODaily.FIODaily(fio)
	print('Daily')
	print('Summary:', daily.summary)
	print('Icon:', daily.icon)

	for day in range(0, daily.days()):
		print('Day', day+1)
		for item in daily.get_day(day).keys():
			print(item + ' : ' + str(daily.get_day(day)[item]))
		# Or access attributes directly for a given minute.
		# daily.day_7_time would also work
		print(daily.day_5_time)
else:
	print('No Daily data')

Get Flags weather data for the requested location

if fio.has_flags() is True:
	from pprint import pprint
	flags = FIOFlags.FIOFlags(fio)
	pprint(vars(flags))
	# Get units directly
	print(flags.units)
else:
	print('No Flags data')

Get Alerts weather data for the requested location It should work just like Flags and the other ones, but at the time I am writing this, I could not find a location with alerts to test on.

A note on time The API returns time in unix time. Although this is a good computer format, it is not particulary human-readable So, to get a more human-sane format, you can do something like this:

import datetime

time = datetime.datetime.fromtimestamp(int(currently.time).strftime('%Y-%m-%d %H:%M:%S')
print('unix time:', currently.time)
print('time:', time)

Output should be like:

unix time: 1448234556
time: 2015-11-22 23:22:36

Issues

To report issues please do it in Github or send me an email.

Documentation

Thanks to pylint complaning, David wrote a docstring for everything. Thanks, David!

License

The code is available under the terms of the Eclipse Public License.