InternetSpeedVisualizer


NameInternetSpeedVisualizer JSON
Version 1.1.0 PyPI version JSON
download
home_page
SummaryInternetSpeedVisualizer is a powerful tool designed to help you visualize and analyze your Internet speed data, collected using the InternetSpeedLogger.
upload_time2023-06-07 10:46:26
maintainer
docs_urlNone
author
requires_python>=3.6
licenseMIT License Copyright (c) 2023 Andreas Menzel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords speedtest speedtest_cli internet internet speed logger monitor visualizer visualize
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # InternetSpeedVisualizer

## Powerful Python Tool for Analyzing Internet Connection Speed

InternetSpeedVisualizer is a tool designed to help you visualize and analyze
your Internet speed data, which you can collect using the
[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger).

## Installation

Installation is as simple as running a pip command:

```bash
pip install InternetSpeedVisualizer
```

## Usage

Once InternetSpeedVisualizer is installed using pip, you can easily execute the
script from anywhere:

```bash
InternetSpeedVisualizer
```

To access detailed execution information, simply type
`InternetSpeedVisualizer --help`:

```
usage: InternetSpeedVisualizer [-h] [--version] -i INPUT [-o OUTPUT]
                               [--width WIDTH] [--height HEIGHT]
                               [-d <min>;<max>] [-u <min>;<max>]
                               [--interactive] [-no]

InternetSpeedVisualizer is a powerful tool designed to help you visualize and
analyze your Internet speed data, collected using the InternetSpeedVisualizer.
            

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -i INPUT, --input INPUT
                        Path to the .csv-log-file generated by
                        InternetSpeedVisualizer.
  -o OUTPUT, --output OUTPUT
                        Path to the line-graph-image that should be created.
  --width WIDTH         Width in inch of the output image. (default: 20)
  --height HEIGHT       Height in inch of the output image. (default: 10)
  -d <min>;<max>, --download <min>;<max>
                        Download speed promised by the ISP. (default:
                        "180;250")
  -u <min>;<max>, --upload <min>;<max>
                        Upload speed promised by the ISP. (default: "35;40")
  --interactive         Show an interactive line-graph. (default: False)
  -no, --no_overwrite   Set this flag to automatically select a similar
                        output-filename, so a potentially already existing
                        file will not be overwritten.

Passing only minimum download speed:
    --download "200;"
Passing only maximum download speed:
    --download ";250"
Passing only minimum upload speed:
    --upload "30;"
Passing only maximum upload speed:
    --upload ";40"
```

## Sample output

Given a sample .csv-file names `internet_speeds.csv`, the following command
generates the following image:

```
InternetSpeedVisualizer -i internet_speeds.csv -o internet_speeds.png -d "180;250" -u "30;40"
```

![Internet Speed Visualizer Preview](images/internet_speeds.png)

## Companion Tool: InternetSpeedLogger

InternetSpeedVisualizer is designed to work in harmony with
[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger).
This companion tool allows you to continuously log your internet speed at
defined intervals.

By saving the data in a CSV file,
[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger)
provides you with a historical log of your internet speeds. This data can then
be visualized using InternetSpeedVisualizer, enabling you to understand trends
and fluctuations in your internet speed over time.

## 👏 Contribution

We warmly welcome and highly appreciate contributions to the
InternetSpeedVisualizer project! Your creative ideas and diligent work can make
a real difference in its development and enhance the user experience.

Multiple ways to contribute:

- **Bug Reports 🐛:** Encountered any issues with the script? Please create a
  new issue in the GitHub repository with as much detail as possible, including
  steps to reproduce the bug, the Python version you're using, and any error
  messages received.
- **Feature Requests 💡:** Got a brilliant idea for improving
  InternetSpeedVisualizer? We'd love to hear about it! Propose new features by
  opening a new issue and using the Feature Request template.
- **Code Contributions 💻:** If you're eager to get hands-on and directly
  contribute to the InternetSpeedVisualizer codebase, we're more than happy to
  welcome your input. Your contributions can help fix bugs, add features,
  improve efficiency, and make the tool more robust and user-friendly.
- **Documentation 📚:** A project is only as good as its documentation. If you
  can improve the readme, comment the code more thoroughly, or create better
  user guides, your input is highly valued and welcome.

Remember, the best way to make successful contributions is to communicate! Feel
free to ask questions and discuss your ideas in the issue tracker.

In your pull request, provide a clear and comprehensive explanation of your
changes and their necessity. This will help us understand the purpose of your
contribution and expedite the review process.

Thank you for your interest in improving InternetSpeedVisualizer! ❤️

## 📜 License

This script is released under the MIT License.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "InternetSpeedVisualizer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "speedtest,speedtest_cli,internet,internet speed,logger,monitor,visualizer,visualize",
    "author": "",
    "author_email": "Andreas Menzel <mail@andreas-menzel.com>",
    "download_url": "https://files.pythonhosted.org/packages/18/54/89da5241df0c5ea533398b5b69b055a84b23e3f897534a68db663ab20a6d/InternetSpeedVisualizer-1.1.0.tar.gz",
    "platform": null,
    "description": "# InternetSpeedVisualizer\n\n## Powerful Python Tool for Analyzing Internet Connection Speed\n\nInternetSpeedVisualizer is a tool designed to help you visualize and analyze\nyour Internet speed data, which you can collect using the\n[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger).\n\n## Installation\n\nInstallation is as simple as running a pip command:\n\n```bash\npip install InternetSpeedVisualizer\n```\n\n## Usage\n\nOnce InternetSpeedVisualizer is installed using pip, you can easily execute the\nscript from anywhere:\n\n```bash\nInternetSpeedVisualizer\n```\n\nTo access detailed execution information, simply type\n`InternetSpeedVisualizer --help`:\n\n```\nusage: InternetSpeedVisualizer [-h] [--version] -i INPUT [-o OUTPUT]\n                               [--width WIDTH] [--height HEIGHT]\n                               [-d <min>;<max>] [-u <min>;<max>]\n                               [--interactive] [-no]\n\nInternetSpeedVisualizer is a powerful tool designed to help you visualize and\nanalyze your Internet speed data, collected using the InternetSpeedVisualizer.\n            \n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  -i INPUT, --input INPUT\n                        Path to the .csv-log-file generated by\n                        InternetSpeedVisualizer.\n  -o OUTPUT, --output OUTPUT\n                        Path to the line-graph-image that should be created.\n  --width WIDTH         Width in inch of the output image. (default: 20)\n  --height HEIGHT       Height in inch of the output image. (default: 10)\n  -d <min>;<max>, --download <min>;<max>\n                        Download speed promised by the ISP. (default:\n                        \"180;250\")\n  -u <min>;<max>, --upload <min>;<max>\n                        Upload speed promised by the ISP. (default: \"35;40\")\n  --interactive         Show an interactive line-graph. (default: False)\n  -no, --no_overwrite   Set this flag to automatically select a similar\n                        output-filename, so a potentially already existing\n                        file will not be overwritten.\n\nPassing only minimum download speed:\n    --download \"200;\"\nPassing only maximum download speed:\n    --download \";250\"\nPassing only minimum upload speed:\n    --upload \"30;\"\nPassing only maximum upload speed:\n    --upload \";40\"\n```\n\n## Sample output\n\nGiven a sample .csv-file names `internet_speeds.csv`, the following command\ngenerates the following image:\n\n```\nInternetSpeedVisualizer -i internet_speeds.csv -o internet_speeds.png -d \"180;250\" -u \"30;40\"\n```\n\n![Internet Speed Visualizer Preview](images/internet_speeds.png)\n\n## Companion Tool: InternetSpeedLogger\n\nInternetSpeedVisualizer is designed to work in harmony with\n[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger).\nThis companion tool allows you to continuously log your internet speed at\ndefined intervals.\n\nBy saving the data in a CSV file,\n[InternetSpeedLogger](https://github.com/Andreas-Menzel/InternetSpeedLogger)\nprovides you with a historical log of your internet speeds. This data can then\nbe visualized using InternetSpeedVisualizer, enabling you to understand trends\nand fluctuations in your internet speed over time.\n\n## \ud83d\udc4f Contribution\n\nWe warmly welcome and highly appreciate contributions to the\nInternetSpeedVisualizer project! Your creative ideas and diligent work can make\na real difference in its development and enhance the user experience.\n\nMultiple ways to contribute:\n\n- **Bug Reports \ud83d\udc1b:** Encountered any issues with the script? Please create a\n  new issue in the GitHub repository with as much detail as possible, including\n  steps to reproduce the bug, the Python version you're using, and any error\n  messages received.\n- **Feature Requests \ud83d\udca1:** Got a brilliant idea for improving\n  InternetSpeedVisualizer? We'd love to hear about it! Propose new features by\n  opening a new issue and using the Feature Request template.\n- **Code Contributions \ud83d\udcbb:** If you're eager to get hands-on and directly\n  contribute to the InternetSpeedVisualizer codebase, we're more than happy to\n  welcome your input. Your contributions can help fix bugs, add features,\n  improve efficiency, and make the tool more robust and user-friendly.\n- **Documentation \ud83d\udcda:** A project is only as good as its documentation. If you\n  can improve the readme, comment the code more thoroughly, or create better\n  user guides, your input is highly valued and welcome.\n\nRemember, the best way to make successful contributions is to communicate! Feel\nfree to ask questions and discuss your ideas in the issue tracker.\n\nIn your pull request, provide a clear and comprehensive explanation of your\nchanges and their necessity. This will help us understand the purpose of your\ncontribution and expedite the review process.\n\nThank you for your interest in improving InternetSpeedVisualizer! \u2764\ufe0f\n\n## \ud83d\udcdc License\n\nThis script is released under the MIT License.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Andreas Menzel  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "InternetSpeedVisualizer is a powerful tool designed to help you visualize and analyze your Internet speed data, collected using the InternetSpeedLogger.",
    "version": "1.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/Andreas-Menzel/InternetSpeedVisualizer/issues",
        "Repository": "https://github.com/Andreas-Menzel/InternetSpeedVisualizer"
    },
    "split_keywords": [
        "speedtest",
        "speedtest_cli",
        "internet",
        "internet speed",
        "logger",
        "monitor",
        "visualizer",
        "visualize"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08937d64d009f2dfad0e4ca87cfe8462b8678d65881e5eddfcf6781c1115182a",
                "md5": "1e9a0a4938f0b9872eccc0312563d79c",
                "sha256": "22978672b5817735676018bf31ead9004eedf5fd42bb4f08c41d52c195cb28f5"
            },
            "downloads": -1,
            "filename": "InternetSpeedVisualizer-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1e9a0a4938f0b9872eccc0312563d79c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7954,
            "upload_time": "2023-06-07T10:46:24",
            "upload_time_iso_8601": "2023-06-07T10:46:24.614785Z",
            "url": "https://files.pythonhosted.org/packages/08/93/7d64d009f2dfad0e4ca87cfe8462b8678d65881e5eddfcf6781c1115182a/InternetSpeedVisualizer-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "185489da5241df0c5ea533398b5b69b055a84b23e3f897534a68db663ab20a6d",
                "md5": "ebb3a17271f8f74a9d3346bb662d3797",
                "sha256": "60dc83297a05236deff253dffa3c50cdebf556fb2e51984c9c4c0e5aeb5171e8"
            },
            "downloads": -1,
            "filename": "InternetSpeedVisualizer-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ebb3a17271f8f74a9d3346bb662d3797",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 7380,
            "upload_time": "2023-06-07T10:46:26",
            "upload_time_iso_8601": "2023-06-07T10:46:26.460184Z",
            "url": "https://files.pythonhosted.org/packages/18/54/89da5241df0c5ea533398b5b69b055a84b23e3f897534a68db663ab20a6d/InternetSpeedVisualizer-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-07 10:46:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Andreas-Menzel",
    "github_project": "InternetSpeedVisualizer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "internetspeedvisualizer"
}
        
Elapsed time: 0.25066s