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
meteofrance.gp web site.
## Install
### From PIP
```bash
pip install vigimeteo-cli
```
### From source
```bash
git clone https://work.ipeos.com/gitlab/vigimeteo/vigimeteo-cli.git vigimeteo-cli
cd vigimeteo-cli
python setup.py install
```
## Usage
### Command Line Tool
```
Vigilance Meteo : French West Indies weather awareness level
Usage:
vigimeteo AREA [--datastore=FILE_PATH] [--quiet] [--verbose]
vigimeteo (-h |--help)
vigimeteo (-v |--version)
Arguments:
AREA geographic area
(gp=Guadeloupe, mq=Martinique, gf=Guyane, idn=Iles du Nord)
Options:
-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
```bash
$ vigimeteo gp
vert
```
Get current level, verbose mode
```bash
$ vigimeteo gp --verbose
Guadeloupe
vert
Pas de vigilance particulière
Département en vigilance verte.Pas de vigilance particulière.
```
Get current level, and store the record
```bash
$ vigimeteo gp --quiet --datastore=/data/vigimeteo.gp.json
```
### Python module
``` py
>>> from vigimeteo_cli import meteoGP
>>> vigilance = meteoGP(area='gp', datastore='/data/vigimeteo.gp.json')
>>> vigilance.scrap()
>>> print(vigilance.bulletin['vigilance'])
>>> vigilance.save()
```
## Licence
This project is distributed under the [GPL V3 licence](LICENSE.md)
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
meteofrance.gp web site.
## Install
### From PIP
```bash
pip install vigimeteo-cli
```
### From source
```bash
git clone https://work.ipeos.com/gitlab/vigimeteo/vigimeteo-cli.git vigimeteo-cli
cd vigimeteo-cli
python setup.py install
```
## Usage
### Command Line Tool
```
Vigilance Meteo : French West Indies weather awareness level
Usage:
vigimeteo AREA [--datastore=FILE_PATH] [--quiet] [--verbose]
vigimeteo (-h |--help)
vigimeteo (-v |--version)
Arguments:
AREA geographic area
(gp=Guadeloupe, mq=Martinique, gf=Guyane, idn=Iles du Nord)
Options:
-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
```bash
$ vigimeteo gp
vert
```
Get current level, verbose mode
```bash
$ vigimeteo gp --verbose
Guadeloupe
vert
Pas de vigilance particulière
Département en vigilance verte.Pas de vigilance particulière.
```
Get current level, and store the record
```bash
$ vigimeteo gp --quiet --datastore=/data/vigimeteo.gp.json
```
### Python module
``` py
>>> from vigimeteo_cli import meteoGP
>>> vigilance = meteoGP(area='gp', datastore='/data/vigimeteo.gp.json')
>>> vigilance.scrap()
>>> print(vigilance.bulletin['vigilance'])
>>> vigilance.save()
```
## Licence
This project is distributed under the [GPL V3 licence](LICENSE.md)
Project details
Release history Release notifications | RSS feed
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)
Built Distribution
Close
Hashes for vigimeteo_cli-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7a0a5d7e30798a3acef61da26b327b26eaf9ffa32814f335a2f2a6c33d6750f |
|
MD5 | 58c9703452068bd22773e81bf878c254 |
|
BLAKE2b-256 | fafcb36be473c4cf54d69e69f740a96e99833126aab4671fc9735b50e235c939 |