README

A PHP 7.1+ (including PHP 8) API to retrieve and parse global weather data from OpenWeatherMap.org. This project aims to normalise the provided data and remove inconsistencies. It is not maintained by OpenWeatherMap and not an official API wrapper.

Documentation

You can find the latest documentation, including installation and usage instructions at https://cmfcmf.github.io/OpenWeatherMap-PHP-API.

Contributing

I'm happy about every pull request you open and issue you find to help make this API more awesome. Please note that it might sometimes take me a while to get back to you. Feel free to ping me if I don't respond.

Gitpod

You can use Gitpod to launch a fully functional development environment right in your browser. Simply click on the following badge:

Vagrant

You can use Vagrant to kick-start your development. Simply run vagrant up and vagrant ssh to start a PHP VM with all dependencies included.

Docker

You can also use Docker to start developing this library. First install dependencies:

docker run --rm --interactive --tty \
    --volume $PWD:/app \
    --user $(id -u):$(id -g) \
    composer update

And then execute the tests:

docker run --rm --interactive --tty \
    --volume $PWD:/app -w /app \
    php bash

> php vendor/bin/phpunit

Documentation

The documentation is built using Docusaurus v2. To run a local developnment server for the docs, execute

cd docs
yarn install
yarn start

License

This project is licensed under the MIT license. Please see the LICENSE file distributed with this source code for further information regarding copyright and licensing.

Be aware that the OpenWeatherMap data is not licensed under the MIT. Check out the following official links to read about the terms, pricing and license of OpenWeatherMap before using their service:

• OpenWeatherMap.org/terms
• OpenWeatherMap.org/appid