Metadata-Version: 2.1
Name: forecastvh
Version: 0.0.1b3
Summary: Let's see the weather outside!
Home-page: https://github.com/MorningStar-png/weathervh-py
License: UNKNOWN
Author: Ilia Fedorovich
Author-email: workplaceilfed@gmail.com
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3

# Weather finder

> Find any weather forecast you need

![PyPI](https://img.shields.io/pypi/v/forecastvh)
[![Build Status](https://travis-ci.com/h3xi/forecastvh-py.svg?branch=master)](https://travis-ci.com/h3xi/forecastvh-py)
[![Coverage Status](https://coveralls.io/repos/github/h3xi/forecastvh-py/badge.svg?branch=master)](https://coveralls.io/github/h3xi/forecastvh-py?branch=master)
![GitHub issues](https://img.shields.io/github/issues/h3xi/forecastvh-py)
[![Maintainability](https://api.codeclimate.com/v1/badges/3784e7d1af07db0d982c/maintainability)](https://codeclimate.com/github/h3xi/forecastvh-py/maintainability)
![GitHub](https://img.shields.io/github/license/h3xi/forecastvh-py)

`forecastvh` finds weather forecast via [OpenWeather API](https://openweathermap.org/current).'

Search parameters:

- *city* - search string (name, author etc)
- *country* - ISO alpha-2 country code (de, fr etc), default: en
- *units* - units format (imperial or metric), default: metric

Returned attributes for each forecast (https://openweathermap.org/current#current_JSON):

- *id* - City ID (e.g., `420006353`)
- *country* - Country code (`GB`)
- *city* - City name (`London`)
- *temp* - Temperature (Default: Metric). (`19.8`)
- *feels_like* - Temperature. This temperature parameter accounts for the human perception of weather. (`19`)
- *pressure* - Atmospheric pressure on the ground level, hPa (`1023`)
- *humidity* - Humidity, % (`100`)
- *wind_speed* - Wind speed. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour. (`1.5`)
- *cloudiness* - Cloudiness, % (`80`)
- *status* - Status code, 200 or 404 (`200`)

## Installation

```sh
pip3 install forecastvh
```

## Usage

```python
>>> import forecastvh
>>> forecast = forecastvh.get_weather("London")
>>> forecast.country
'GB'
>>> forecast.temp
'18.01'
>>> forecast.cloudiness
'97	'
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Make sure to add or update tests as appropriate.

Use [Black](https://black.readthedocs.io/en/stable/) for code formatting and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) for commit messages.

## License

[MIT](https://choosealicense.com/licenses/mit/)

