README

This package provides a Laravel client for the Windy API (https://api.windy.com/).

Installation

Install the package via composer:

composer require bvrignaud/windy-api

You must add the WINDY_API_KEY environment variable to your .env file.`

WINDY_API_KEY=

You can publish the config file with:

php artisan vendor:publish --tag="windy-api-config"

This is the contents of the published config file:

return [
    'key' => env('WINDY_API_KEY'),
];

Usage

$windy = new WindyApi\Webcams();

$webcams = $windy->getWebcams(new WindyApi\Requests\WebcamsRequest(
    lang: 'fr',
    nearby: new WindyApi\Requests\NearbyRequest(46.48848, -1.79662, 10),
    include: [
        WindyApi\Enums\IncludeEnum::categories,
        WindyApi\Enums\IncludeEnum::images,
        WindyApi\Enums\IncludeEnum::player,
        WindyApi\Enums\IncludeEnum::urls,
    ]
));

$webcam = $windy->getWebcamById(
    1481061744,
    new WindyApi\Requests\WebcamRequest(
        include: [
            WindyApi\Enums\IncludeEnum::categories,
            WindyApi\Enums\IncludeEnum::images,
            WindyApi\Enums\IncludeEnum::player,
            WindyApi\Enums\IncludeEnum::urls,
        ]
    )
);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

bvrignaud / windy-api

Maintainers

Details