Metadata-Version: 1.0
Name: requests-forecast
Version: 0.4.0
Summary: A minimalist Forecast.io API client.
Home-page: https://github.com/jefftriplett/requests-forecast
Author: Jeff Triplett
Author-email: jeff.triplett@gmail.com
License: BSD
Description: =================
        requests-forecast
        =================
        
        .. image:: https://badge.fury.io/py/requests-forecast.png
            :target: http://badge.fury.io/py/requests-forecast
        
        .. image:: https://travis-ci.org/jefftriplett/requests-forecast.png?branch=master
                :target: https://travis-ci.org/jefftriplett/requests-forecast
        
        .. image:: https://pypip.in/d/requests-forecast/badge.png
                :target: https://crate.io/packages/requests-forecast?version=latest
        
        For complete docs and API options see: https://developer.forecast.io/docs/v2
        
        
        Requirements
        ============
        
        * Python 2.5+
        * requests 1.2.0+
        
        
        Installation
        ============
        
        To install requests-forecast, simply:
        
        .. code-block:: bash
        
            $ pip install requests-forecast
        
        
        Documentation
        =============
        
        - Development version: http://requests-forecast.rtfd.org.
        
        
        Quickstart
        ==========
        
        
        Creating a client
        -----------------
        
        ::
        
            >>> from requests_forecast import Forecast
            >>> forecast = Forecast(apikey='FORECAST_API_KEY', latitude=38.9717, longitude=-95.235)
        
        
        Getting the current conditions
        ------------------------------
        
        ::
        
            >>> current = forecast.get_currently()
            >>> print current['temperature']
            58.9
        
        
        Getting minutely conditions
        ---------------------------
        
        ::
        
            >>> current = forecast.get_minutely()
            >>> current['summary']
            u'Mostly cloudy for the hour.'
            >>> current['data'][0].keys()
            [u'precipIntensity', u'time']
        
        
        
        Getting hourly conditions
        -------------------------
        
        ::
        
            >>> current = forecast.get_hourly()
            >>> current['temperature']
            59.52
        
        
            >>> forecast.get_hourly()['summary']
            Mostly cloudy until tomorrow afternoon.
        
            >>> forecast.get_hourly()['data'][0]['temperature']
            >>> 59.52
        
        
        Getting daily conditions
        ------------------------
        
        ::
        
            >>> forecast.get_daily()['summary']
            u'Mixed precipitation off-and-on throughout the week; temperatures peaking at 70\xb0 on Sunday.'
            >>> forecast.get_daily()['data'][0]['temperatureMax']
            63.85
            >>> forecast.get_daily()['data'][0]['temperatureMin']
            35.05
        
        
        Getting alerts
        --------------
        
        ::
        
            >>> forecast.alerts()
            {
              "expires": 1366898400,
              "uri": "http://alerts.weather.gov/cap/wwacapget.php?x=KS124EFAC89CD0.FreezeWarning.124EFAD6F320KS.TOPNPWTOP.8ab7d76a4db42b9136a1a6849a631097",
              "title": "Freeze Warning for Douglas, KS"
            }
        
        
        Example usage
        ~~~~~~~~~~~~~
        
        ::
        
            from datetime import datetime
            from requests_forecast import Forecast
        
            forecast = Forecast(apikey='YOUR-API-KEY')
            data = forecast.get(latitude=38.9717, longitude=-95.235)
        
            >>> forecast.get_currently()['temperature']
            58.9
        
            data = forecast.get(latitude=38.9717, longitude=-95.235,
                time=datetime(year=2013, month=12, day=29))
        
            >>> forecast.get_currently()['temperature']
            58.9
        
            >>> forecast.get_currently()['temperature']
            36.75
        
        
        License
        =======
        
        New BSD
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
