Metadata-Version: 2.1
Name: wetterdienst
Version: 0.4.0
Summary: Python library to ease access to open weather data
Home-page: https://wetterdienst.readthedocs.io/
License: MIT
Keywords: dwd,deutscher wetterdienst,german weather service,weather,weather-data,open-data,observations,historical-data,forecasts
Author: Benjamin Gutzmann
Author-email: gutzemann@gmail.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Communications
Classifier: Topic :: Database
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Archiving
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Provides-Extra: ipython
Requires-Dist: aiofiles (>=0.4.0,<0.5.0)
Requires-Dist: beautifulsoup4 (>=4.9.1,<5.0.0)
Requires-Dist: cachetools (>=3.1.1,<4.0.0)
Requires-Dist: dateparser (>=0.7.4,<0.8.0)
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: fire (>=0.3.1,<0.4.0)
Requires-Dist: h5py (==2.10.0)
Requires-Dist: importlib_metadata (==1.6.1); python_version < "3.8"
Requires-Dist: ipython (>=7.10.1,<8.0.0); extra == "ipython"
Requires-Dist: ipython-genutils (>=0.2.0,<0.3.0); extra == "ipython"
Requires-Dist: matplotlib (>=3.0.3,<4.0.0); extra == "ipython"
Requires-Dist: munch (>=2.5.0,<3.0.0)
Requires-Dist: numpy (==1.18.3)
Requires-Dist: pandas (==1.0.4)
Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
Requires-Dist: requests (>=2.24.0,<3.0.0)
Requires-Dist: scipy (==1.4.1)
Requires-Dist: tables (==3.6.1)
Project-URL: Repository, https://github.com/earthobservations/wetterdienst
Description-Content-Type: text/x-rst

Introduction to wetterdienst
############################

.. image:: https://github.com/earthobservations/wetterdienst/workflows/Tests/badge.svg
   :target: https://github.com/earthobservations/wetterdienst/actions?workflow=Tests
.. image:: https://codecov.io/gh/earthobservations/wetterdienst/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/earthobservations/wetterdienst
.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest
    :target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black


.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg
   :target: https://pypi.python.org/pypi/wetterdienst/
.. image:: https://img.shields.io/pypi/v/wetterdienst.svg
   :target: https://pypi.org/project/wetterdienst/
.. image:: https://img.shields.io/pypi/status/wetterdienst.svg
   :target: https://pypi.python.org/pypi/wetterdienst/
.. image:: https://pepy.tech/badge/wetterdienst/month
   :target: https://pepy.tech/project/wetterdienst/month
.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst
   :target: https://github.com/earthobservations/wetterdienst/blob/master/LICENSE.rst
.. image:: https://zenodo.org/badge/160953150.svg
   :target: https://zenodo.org/badge/latestdoi/160953150


Welcome to wetterdienst, your friendly weather service library for Python from the
neighbourhood! We are an group of people, who try to make access to weather data in
Python feel like a warm summer breeze, similar to other projects like
`rdwd <https://github.com/brry/rdwd>`_ ,
which originally drew our interest in this project. As we reach to provide you with data
from multiple weather services, we are still stuck with this one weather service from
Germany, that has questioned our believe in humanity. But we think we are at good
condition to make further progress to soon fully cover the German weather service, right
after finishing this documentation. But now it's up to you to take a closer look at
what we did here.

**CAUTION**
Although the data is specified as being open, the DWD asks you to reference them as
Copyright owner. To check out further, take a look at
`Open Data at the DWD <https://www.dwd.de/EN/ourservices/opendata/opendata.html>`_
and the
`Official Copyright <https://www.dwd.de/EN/service/copyright/copyright_artikel.html?nn=495490&lsbId=627548>`_

The full documentation of wetterdienst is available at:
https://wetterdienst.readthedocs.io/en/latest/

To keep you updated about added features etc. we provide a
`Changelog <https://wetterdienst.readthedocs.io/en/latest/pages/development.html#current>`_
. Furthermore to get insight on which data we have made available the section
`Data Coverage <https://wetterdienst.readthedocs.io/en/latest/pages/data_coverage.html>`_
may be of special interest for you.

Getting started
***************

Run the following

.. code-block:: Python

    pip install wetterdienst

to make wetterdienst available in your current environment. To get some historical
observed station data call

.. code-block:: Python

    from wetterdienst import collect_dwd_data
    from wetterdienst import Parameter, PeriodType, TimeResolution

    station_data = collect_dwd_data(
        station_ids=[1048],
        parameter=Parameter.CLIMATE_SUMMARY,
        time_resolution=TimeResolution.DAILY,
        period_type=PeriodType.HISTORICAL
    )

For other examples and functionality such getting metadata, running the library in a
Docker image and a client take a look at the
`API <https://wetterdienst.readthedocs.io/en/latest/pages/api.html>`_
section, which will be constantly updated with new functions. Also don't miss out our
`examples <https://github.com/earthobservations/wetterdienst/tree/master/example>`_
.




