BlueWeather’s documentation

Here you will find all the documentation needed to create your own plugins, or to add to BlueWeather’s Codebase.

This project is still early in development, so most of its features are missing, or half-baked. Please keep this in mind when reading this documentation.

BlueWeather is a python web-app built to manage and serve the weather from your Personal Weather Station (PWS). It is highly extensible allowing for virtually infinite possibilies to measure the weather. In this documentation, you will learn how to develop your own weather driver, as well as create plugins that can process weather data, or interact with the user.

There is also documentation of the internal workings of BlueWeather, mostly for my own sanity.

Contents

• Plugins
  • Creating A Plugin
  • API Reference
  • Hooks
• Config
  • Secret Key
  • Debug
  • Time Zone
  • Commands
  • Web
  • Extensions
• ReST API
  • General Usage
  • Weather API
  • Settings
• Internal Docs
  • Apps
  • Templates
  • Plugins

Installation

To install BlueWeather, the first step is to download it, which you can do by

Note

Required Software

• Python 3.6
• npm

git clone https://github.com/ttocsneb/blueweather.git

Once you have the source downloaded, you can install it by running

cd blueweather
python -m pip install .
npm i

To start the server

python manage.py runserver

Contribute

• Issue Tracker: github.com/ttocsneb/blueweather/issues
• Source Code: github.com/ttocsneb/blueweather

License

The project is licensed under GNU General Public License v3.0