Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guykh/py-ims-envista
A Python Wrapper for IMS Envista sydstem
https://github.com/guykh/py-ims-envista
Last synced: 3 months ago
JSON representation
A Python Wrapper for IMS Envista sydstem
- Host: GitHub
- URL: https://github.com/guykh/py-ims-envista
- Owner: GuyKh
- License: mit
- Created: 2023-02-21T19:09:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T11:28:49.000Z (3 months ago)
- Last Synced: 2024-10-04T14:01:44.763Z (3 months ago)
- Language: Python
- Size: 182 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# IMS Envista
==========================
[](https://pypi.python.org/pypi/ims-envista)
[](https://pepy.tech/project/ims-envista)
[](https://github.com/GuyKh/pi-ims-envista/actions)
[](https://scrutinizer-ci.com/g/GuyKh/py-ims-envista?b=main)
[](https://img.shields.io/pypi/format/ims-envista)
*ims_envista* is an unofficial IMS (Israel Meteorological Service) python API wrapper for Envista service.
## Features supported
* Get latest meteorological readings from IMS Envista
* Get measurement data by region, station and date range.
* Get Daily and Monthly readings by measurement station.
## Components and Frameworks used
* [aiohttp](https://pypi.org/project/aiohttp/)
* [Loguru](https://pypi.org/project/loguru/)
* [urllib3](https://pypi.org/project/urllib3/)
## Installing
```bash
pip3 install --upgrade ims-envista
```
## Working with the API
weatheril can be configured to retrive forecast information for specific location. when initiating the library you must set the location id and language (Currently only he and en are supported)
### Getting an IMS Token
You can read about the API and about how to get a token [here](https://ims.gov.il/en/ObservationDataAPI) - signing terms of use, etc.
```python
from ims_envista import IMSEnvista
# Create IMS object with Token
ims = IMSEnvista("2cc57fb1-cda5-4965-af12-b397e5b8eb32")
# Get JERUSALEM stations for getting an id
[station for station in await ims.get_all_stations_info() if station.name.startswith("JERUSALEM")]
> [JERUSALEM GIVAT RAM(22) - Location: [Lat - 31.771 / Long - 35.197], Active, Owner: ims, RegionId: 7, Monitors: [
Rain(mm), WSmax(m / sec), WDmax(deg), WS(m / sec), WD(deg), STDwd(deg), TD(degC), RH( %), TDmax(degC), TDmin(
degC), Grad(w / m2), DiffR(w / m2), WS1mm(m / sec), Ws10mm(m / sec), Time(hhmm), NIP(
w / m2)], StationTarget:, JERUSALEM
CENTRE(23) - Location: [Lat - 31.781 / Long - 35.222], Active, Owner: ims, RegionId: 7, Monitors: [Rain(mm),
WSmax(m / sec),
WDmax(deg),
WS(m / sec), WD(deg),
STDwd(deg), TD(degC),
TDmax(degC),
TDmin(degC),
WS1mm(m / sec),
Ws10mm(m / sec),
Time(hhmm), BP(mb),
RH( %)], StationTarget:, JERUSALEM
CENTRE_1m(248) - Location: [Lat - 31.7806 / Long - 35.2217], Active, Owner: ims, RegionId: 7, Monitors: [Rain_1_min(mm),
Rain_Corr(
mm)], StationTarget:, JERUSALEM
GIVAT
RAM_1m(249) - Location: [Lat - 31.7704 / Long - 35.1973], Active, Owner: ims, RegionId: 7, Monitors: [Rain_1_min(mm),
Rain_Corr(
mm)], StationTarget:]
# Get latest data by a station id
await ims.get_latest_station_data(23)
> Station(23), Data: [Station: 23, Date: 2023 - 02 - 21
12: 00:00 + 02: 00, Readings: [(TD: 17.6°C), (TDmax: 17.8°C), (TDmin: 17.5°C), (RH: 58.0 %), (Rain: 0.0mm),
(WS: 2.8m / s), (WSmax: 3.7m / s), (WD: 285.0deg), (WDmax: 289.0deg), (STDwd: 10.5deg),
(WS1mm: 3.4m / s), (WS10mm: 2.9m / s)]]
```
## Methods
| Method | Description | Parameters | Returns |
|--- |--- |--- |--- |
| get_latest_station_data | Get Latest Station Readings | station_id: int,
(optional) channel_id: int | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_earliest_station_data | Get Earliest Station Readings | station_id: int,
(optional) channel_id: int | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_station_data_from_date | Get Station Reading from a specific date | station_id: int,
date: datetime,
(optional) channel_id: int | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_station_data_by_date_range | Get Station Readings from a date range | station_id: int,
from_date: datetime,
to_date: datetime,
(optional) channel_id: int | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_daily_station_data | Get Daily Station Readings | station_id: int,
(optional) channel_id: int | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_monthly_station_data | Get Monthly Station Readings | station_id: int,
(optional) channel_id: int,
(optional) month: str, [e.g. 03]
(optional) year: str [e.g. 2020] | [StationMeteorologicalReadings](./ims_envista/meteo_data.py) |
| get_all_stations_data | Get Station Info of all stations | | list[[Station](./ims_envista/station_data.py)] |
| get_station_data | Get Station Info by station_id | station_id: int | [Station](./ims_envista/station_data.py) |
| get_all_regions_data | Get Region Info of all regions | | list[[Region](./ims_envista/station_data.py)] |
| get_region_info | Get Region Info by region_id | station_id: int | [Region](./ims_envista/station_data.py) |
| get_metric_descriptions | Get Station Measurements Description | | list[IMSVariable](./ims_envista/ims_variable.py) |
## Local Development
### Clone from Github
Clone the repo from GitHub
```
git clone [email protected]:GuyKh/ims-envista.git
```
### Requirements
Package requirements are handled using pip. To install them do
```
pip install -r requirements.txt
```
### Local Installation
To install locally:
```
python setup.py install
```
## Tests
Testing is set up using [pytest](http://pytest.org) and coverage is handled
with the pytest-cov plugin.
Run your tests with ```py.test``` in the root directory.
Coverage is ran by default and is set in the ```pytest.ini``` file.
To see an html output of coverage open ```htmlcov/index.html``` after running the tests.