Metadata-Version: 2.1
Name: pyopenweather
Version: 0.1.0
Summary: Python wrapper for OpenWeather API
Home-page: https://github.com/gsornsen/pyopenweather
Author: Gerald Sornsen
Author-email: gerald@sornsen.io
License: MIT
Description: # pyopenweather
        
        pyopenweather is a lightweight asynchronous Python wrapper for the [OpenWeatherMap Current Weather Data API](https://openweathermap.org/current)
        
        ## Badges
        
        [![Build Status](https://api.travis-ci.com/gsornsen/pyopenweather.svg)](https://travis-ci.com/github/gsornsen/pyopenweather)
        [![Codacy Badge](https://app.codacy.com/project/badge/Grade/cca3c27dfeb541978f507efc06ae0d2e)](https://www.codacy.com/gh/gsornsen/pyopenweather/dashboard)
        [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/cca3c27dfeb541978f507efc06ae0d2e)](https://www.codacy.com/gh/gsornsen/pyopenweather/dashboard)
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pyopenweather.
        
        ```bash
        pip install pyopenweather
        ```
        
        ## Usage
        
        ### API Key
        
        OpenWeatherMap APIs require an API key to provide valid responses. Please obtain an API key on the [OpenWeatherMap website](https://home.openweathermap.org/users/sign_up).
        
        ### Environment Variables
        
        pyopenweather will search for the following environment variables when the `Weather` class is instantiated:
        
        - `OPENWEATHER_API_KEY`
        - `LATITUDE`
        - `LONGITUDE`
        
        #### `OPENWEATHER_API_KEY`
        
        If you set the API key and the environment variable `OPENWEATHER_API_KEY` the library will use it on instantiation, otherwise the API key can be passed in as the `api_key` parameter.
        
        #### `LATITUDE`
        
        If you set the `LATITUDE` environment variable, the library will use it on instantiation, otherwise the latitude can be passed in as the `lat` parameter.
        
        #### `LONGITUDE`
        
        If you set the `LONGITUDE` environment variable, the library will use it on instantiation, otherwise the longitude can be passed in as the `long` parameter.
        
        ### Examples
        
        #### With Environment Variables
        
        ```python
        from pyopenweather.weather import Weather
        
        weather = Weather()
        
        weather.longitude # returns longitude
        weather.latitude # returns latitude
        weather.temperature # returns temperature
        weather.pressure # returns temperatuire
        ```
        
        #### Without Environment Variables
        
        ```python
        from pyopenweather.weather import Weather
        
        weather = Weather(lat=37.34, long=-121.89, api_key='abcdef123456')
        
        weather.longitude # returns longitude
        weather.latitude # returns latitude
        weather.temperature # returns temperature
        weather.pressure # returns temperatuire
        ```
        
        ## Contributing
        
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        Please make sure to update tests as appropriate.
        
        ## License
        
        [MIT](https://choosealicense.com/licenses/mit/)
        
Keywords: openweathermap libary web api wrapper client wind temperature humidity
Platform: Posix; MacOS X; Windows
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Description-Content-Type: text/markdown
