Skip to main content

Get current French West Indies weather awareness level (Vigilance Meteo)

Project description

# Vigimeteo CLI

This module provides module and command line tool to retrieve official current
weathe awareness level (*vigilance météo*) for French West Indies areas
(Guadeloupe, Martinique, Saint Martin/Saint Barth and french Guyana) scraping web site.

## Install

### From PIP

pip install vigimeteo-cli

### From source

git clone vigimeteo-cli
cd vigimeteo-cli
python install

## Usage

### Command Line Tool

Vigilance Meteo : French West Indies weather awareness level
vigimeteo AREA [--datastore=FILE_PATH] [--quiet] [--verbose]
vigimeteo (-h |--help)
vigimeteo (-v |--version)

AREA geographic area
(gp=Guadeloupe, mq=Martinique, gf=Guyane, idn=Iles du Nord)

-h --help Shows this help message and exit
-v --version Shows version number and exit
--datastore=FILE_PATH Datastore json file path (no datastore = no save)
--quiet print less text
--verbose print more text
#### Examples

Get current level for GP

$ vigimeteo gp

Get current level, verbose mode
$ vigimeteo gp --verbose
Pas de vigilance particulière
Département en vigilance verte.Pas de vigilance particulière.

Get current level, and store the record
$ vigimeteo gp --quiet --datastore=/data/

### Python module
``` py
>>> from vigimeteo_cli import meteoGP
>>> vigilance = meteoGP(area='gp', datastore='/data/')
>>> vigilance.scrap()
>>> print(vigilance.bulletin['vigilance'])

## Licence

This project is distributed under the [GPL V3 licence](

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vigimeteo_cli-0.5.0.tar.gz (18.3 kB view hashes)

Uploaded Source

Built Distribution

vigimeteo_cli-0.5.0-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page