Metadata-Version: 2.1
Name: speedtest-http
Version: 0.0.5
Summary: Visualize data from speedtest_sampler in a web app
Home-page: https://github.com/shuntingyard/speedtest_http
Author: Tobias Frei
Author-email: shuntingard@gmail.com
License: mit
Description: speedtest_http
        ==============
        
        Visualize data generated by
        `speedtest-cli <https://github.com/sivel/speedtest-cli>`_ in a web app
        powered by `Plotly <https://plot.ly/python/>`_
        
        .. image:: https://img.shields.io/pypi/v/speedtest-http.svg
                :target: https://pypi.python.org/pypi/speedtest-http/
                :alt: Latest Version
        .. image:: https://travis-ci.com/shuntingyard/speedtest_http.svg?branch=master
                :target: https://travis-ci.com/shuntingyard/speedtest_http 
                :alt: Travis
        .. image:: https://img.shields.io/pypi/l/speedtest-http.svg
                :target: http://github.com/shuntingyard/speedtest_http/blob/master/LICENSE.txt 
                :alt: License
        .. image:: https://img.shields.io/docker/cloud/build/shuntingyard/speedtest_http.svg
                :target: https://cloud.docker.com/repository/docker/shuntingyard/speedtest_http/builds 
                :alt: Docker Image
        .. image:: https://img.shields.io/pypi/pyversions/speedtest-http.svg
                :target: https://pypi.python.org/pypi/speedtest-http/
                :alt: Versions
        
        Screenshots
        -----------
        
        Desktop
        ~~~~~~~
        
        .. image:: static/Heatmap30.png
                :alt: Desktop Heatmap
                :scale: 100 %
        
        Android
        ~~~~~~~
        
        .. image:: static/LineplotTodayAndroid.png
                :alt: Android Lineplot
                :scale: 100 %
        
        Description
        -----------
        
        Web app for visualizing internet uplink speeds. Environments supported so far:
        
        - Docker container
        - GNU/Linux hosts with Python >= 3.6 installed
        
        (Other POSIX systems and Windows need testing.)
        
        Recent changes
        --------------
        
        - Experimental graph for download speed densities (3D) added
        
        Install and run
        ---------------
        
        dockerhub
        ~~~~~~~~~
        
        Get up and running instantly, with a speedtest.csv file in your home dir and
        logs written to stdout.
        
        ::
        
           # Please adapt details (container timezone, sitename) to your needs.
        
           docker run -ti -p 80:5000 -v ~:/root -e FLASK_DEBUG=1 -e "TZ=EST" \
              -e "INFILE=/root/speedtest.csv" -e "SITENAME=my provider" \
              shuntingyard/speedtest_http
        
        pip / easy\_install
        ~~~~~~~~~~~~~~~~~~~
        
        ::
        
           pip install speedtest_http
        
        or
        
        ::
        
           easy_install speedtest_http
        
        Github
        ~~~~~~
        
        ::
        
           pip install git+https://github.com/shuntingyard/speedtest_http.git
        
        or
        
        ::
        
           git clone https://github.com/shuntingyard/speedtest_http.git
           cd speedtest_http
           python setup.py install
        
        run in shell environments
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ::
        
           # Please adapt env variables, host, port according to your needs.
        
           INFILE=~/data/speedtest.csv \
           LOGDIR=/tmp \
           SITENAME="my provider" \
           FLASK_APP=speedtest_http \
           FLASK_DEBUG=0 \
           python -m flask run -h 0.0.0.0 -p 8080
        
        Changelog
        ---------
        
        Version 0.0.5
        ~~~~~~~~~~~~~
        
        - Experimental graph for download speed densities (3D) added
        
        Version 0.0.4
        ~~~~~~~~~~~~~
        
        - Using new `speedtest_reader <https://pypi.org/project/speedtest-reader/>`_ API
          
        Version 0.0.3
        ~~~~~~~~~~~~~
        
        - All graphs migrated from Dash to Plotly
        
Platform: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: System :: Networking
Requires-Python: >= 3.6
Provides-Extra: testing
