# trackyournet
A simple command-line app that runs an internet speedtest in a determined interval of time, ~~so you can blame your internet provider because of their slow internet~~.
You can install trackyournet with pip:
```
pip install trackyournet
```
## How to use?
After installing use the ``trackyournet`` command on your terminal, check the usage above.
```
trackyournet [-h] -u {week, day, hour, min} -f FILE [-r REPEAT] interval
```
``interval`` is the interval between speedtests. _(Required; Integer)_
``-u`` or ``--unit`` is the unit of ``interval``: week, day, hour, or min (Minute). _(Required; String)_
``-f`` or ``--file`` receives a path pointing to an SQLite database or a directory where the data will be allocated (The database will be created if it doesn't exist). _(Required; String)_
``-r`` or ``--repeat`` is the amount of speedtest that will be run before exiting. _(Optional; Integer)_
``-h`` or ``--help`` prints the help message.
**After starting, you can stop the application using ``Ctrl + C`` (Or whatever your terminal's abort key biding is). If ``repeat`` is passed it will stop running automatically after running the determined amount of speedstests.**
**NOTE**: Stopping the application with ``Ctrl + C`` while a speedtest is being run/registered may cause some problems with the database.
## Example
Let's say you would like to run ten speedtests with an interval of 15 minutes between them:
```
trackyournet 15 -u min -f {Your file/dir path here!} -r 10
```
## Final Message
It's my first command line application and the first project I'm uploading to PyPI, so if you find a bug or have a suggestion, please, post it on [issues](https://github.com/VictorioMaculan/internet-speed-tracker/issues).
(By the way, I pretend to add more ways of outputting the data)
Raw data
{
"_id": null,
"home_page": "https://github.com/VictorioMaculan/internet-speed-tracker",
"name": "trackyournet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "speedtest,speed test,internet speed,cli",
"author": "Victorio H. S. Maculan",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cf/94/0cb9b755525b2f39e37d547f31915568aa2be9aaf4c1d1b92052a9a75a83/trackyournet-1.0.tar.gz",
"platform": null,
"description": "# trackyournet\r\n A simple command-line app that runs an internet speedtest in a determined interval of time, ~~so you can blame your internet provider because of their slow internet~~.\r\n\r\n You can install trackyournet with pip:\r\n\r\n ```\r\n pip install trackyournet\r\n ```\r\n\r\n ## How to use?\r\n After installing use the ``trackyournet`` command on your terminal, check the usage above.\r\n\r\n ```\r\n trackyournet [-h] -u {week, day, hour, min} -f FILE [-r REPEAT] interval\r\n ```\r\n\r\n ``interval`` is the interval between speedtests. _(Required; Integer)_\r\n \r\n ``-u`` or ``--unit`` is the unit of ``interval``: week, day, hour, or min (Minute). _(Required; String)_\r\n\r\n ``-f`` or ``--file`` receives a path pointing to an SQLite database or a directory where the data will be allocated (The database will be created if it doesn't exist). _(Required; String)_\r\n\r\n ``-r`` or ``--repeat`` is the amount of speedtest that will be run before exiting. _(Optional; Integer)_\r\n\r\n ``-h`` or ``--help`` prints the help message.\r\n \r\n **After starting, you can stop the application using ``Ctrl + C`` (Or whatever your terminal's abort key biding is). If ``repeat`` is passed it will stop running automatically after running the determined amount of speedstests.** \r\n\r\n **NOTE**: Stopping the application with ``Ctrl + C`` while a speedtest is being run/registered may cause some problems with the database.\r\n\r\n ## Example\r\n Let's say you would like to run ten speedtests with an interval of 15 minutes between them:\r\n \r\n ```\r\n trackyournet 15 -u min -f {Your file/dir path here!} -r 10\r\n ```\r\n \r\n ## Final Message\r\n It's my first command line application and the first project I'm uploading to PyPI, so if you find a bug or have a suggestion, please, post it on [issues](https://github.com/VictorioMaculan/internet-speed-tracker/issues).\r\n\r\n (By the way, I pretend to add more ways of outputting the data)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple command-line app that runs a internet speedtest in a determined interval of time",
"version": "1.0",
"project_urls": {
"Bug Reports or Suggestions": "https://github.com/VictorioMaculan/internet-speed-tracker/issues",
"Homepage": "https://github.com/VictorioMaculan/internet-speed-tracker"
},
"split_keywords": [
"speedtest",
"speed test",
"internet speed",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d84d45e4012a1ca09c327055a1e43664bfd4f1bdf149b827b138445c474844f7",
"md5": "93de83301fa33bf07c42c5517f378376",
"sha256": "542dc087405167b64d100f9db5059712783d3b367ebdc787ee7c9e89cb07566a"
},
"downloads": -1,
"filename": "trackyournet-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93de83301fa33bf07c42c5517f378376",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2313,
"upload_time": "2024-01-28T22:26:18",
"upload_time_iso_8601": "2024-01-28T22:26:18.278248Z",
"url": "https://files.pythonhosted.org/packages/d8/4d/45e4012a1ca09c327055a1e43664bfd4f1bdf149b827b138445c474844f7/trackyournet-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf940cb9b755525b2f39e37d547f31915568aa2be9aaf4c1d1b92052a9a75a83",
"md5": "756847c21a97aedb796ad9e21ebf8de6",
"sha256": "f9bf59f52e70faff47abc99461edb9954b17341264722b1fb942d91de5e28591"
},
"downloads": -1,
"filename": "trackyournet-1.0.tar.gz",
"has_sig": false,
"md5_digest": "756847c21a97aedb796ad9e21ebf8de6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3191,
"upload_time": "2024-01-28T22:26:20",
"upload_time_iso_8601": "2024-01-28T22:26:20.001852Z",
"url": "https://files.pythonhosted.org/packages/cf/94/0cb9b755525b2f39e37d547f31915568aa2be9aaf4c1d1b92052a9a75a83/trackyournet-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 22:26:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VictorioMaculan",
"github_project": "internet-speed-tracker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "trackyournet"
}
JSON
