Martin-Louis Bright > DarkSky-API-0.02 > DarkSky::API

Download:
DarkSky-API-0.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source   Latest Release: DarkSky-API-0.05

NAME ^

DarkSky::API - The great new DarkSky::API!

VERSION ^

Version 0.02

SYNOPSIS ^

Perl module for retrieving data from the Dark Sky API. The Dark Sky API lets you query for short-term precipitation forecast data at geographical points inside the United States.

    use DarkSky::API;

    my $darksky = DarkSky::API->new( api_key => '<your key here>' );
    
    # Returns a forecast for the next hour at a given location.
    my $forecast = $darksky->forecast( '42.7243', '-73.6927' );

    # Returns a brief forecast for the next hour at a given location.
    my $brief_forecast = $darksky->brief_forecast( '42.7243', '-73.6927' );

    # Returns forecasts for a collection of arbitrary points.
    my $precipitation = $darksky->precipitation(['42.7','-73.6',1325607100,'42.0','-73.0',1325607791]);

    # Returns a list of interesting storms happening right now.
    my $interesting_storms = $darksky->interesting();
    
    ...

SUBROUTINES/METHODS ^

forecast

Returns a forecast for the next hour at a given location.

  my $forecast = $darksky->forecast( '42.7243', '-73.6927' );

brief_forecast

Returns a brief forecast for the next hour at a given location.

  my $brief_forecast = $darksky->brief_forecast( '42.7243', '-73.6927' );

precipitation

Returns forecasts for a collection of arbitrary points.

  my $precipitation = $darksky->precipitation(['42.7','-73.6',1325607100,'42.0','-73.0',1325607791]);

interesting

Returns a list of interesting storms happening right now.

    my $interesting_storms = $darksky->interesting();

AUTHOR ^

Martin-Louis Bright, <mlbright at gmail.com>

BUGS ^

Please report any bugs or feature requests to bug-darksky-api at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DarkSky-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc DarkSky::API

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2012 Martin-Louis Bright.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

syntax highlighting: