Metadata-Version: 1.1
Name: telraam-data
Version: 0.2.3
Summary: A friendly package to download traffic count data from Telraam.net.
Home-page: https://github.com/barentsen/telraam-data
Author: Geert Barentsen
Author-email: geert@barentsen.be
License: MIT
Description: telraam-data
        =============
        
        **A friendly Python package to download traffic count data from Telraam.net.**
        
        The *telraam_data* package enables you to retrieve traffic count data from the
        `Telraam Project <https://telraam.net>`_ API into ``pandas.DataFrame`` objects.
        
        
        Examples
        --------
        
        Downloading hourly counts for one segment
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: python
        
          from telraam_data import download_segment
          data = download_segment(segment_id=1003073114, fmt="per-hour")
          data.to_excel("hourly-counts.xls")
        
        
        Downloading daily counts for all segments
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: python
        
          data = download_segment(segment_id="all", fmt="per-day")
          data.to_csv("daily-counts.csv")
        
        
        Plotting weekly average counts for all segments
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code-block:: python
        
          data = download_segment("all", time_start="2020-01-01 00:00:00Z",
                                  time_end="2021-01-01 00:00:00Z", fmt="per-day")
          weekly_average = data.set_index('date').resample('7D').mean() * 7
          weekly_average.plot(y=["car", "bike", "pedestrian"], marker='o')
        
        
        Installation
        ------------
        
        If you have a working version of Python on your system, you can install the package using:
        
        .. code-block:: bash
        
          pip install telraam-data
        
        
        Notes
        -----
        
        * This is a third-party package not officially affiliated with the Telraam project.
        * The Telraam API is documented at `<https://telraam-api.net>`_.
        * Telraam's data is made available under the CC BY 4.0 license. Thanks Telraam!
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
