Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vyahello/speedtest

🏃‍♂️ Test your internet connection bandwidth (python + pytest + travisCI)
https://github.com/vyahello/speedtest

bandwidth cli internet speedtest

Last synced: about 2 months ago
JSON representation

🏃‍♂️ Test your internet connection bandwidth (python + pytest + travisCI)

Host: GitHub
URL: https://github.com/vyahello/speedtest
Owner: vyahello
License: mit
Created: 2020-07-26T18:17:15.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-06-02T09:32:52.000Z (over 3 years ago)
Last Synced: 2023-03-06T12:45:00.593Z (almost 2 years ago)
Topics: bandwidth, cli, internet, speedtest
Language: Shell
Homepage:
Size: 39.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        ![Screenshot](logo.png)

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Checked with pylint](https://img.shields.io/badge/pylint-checked-blue)](https://www.pylint.org)

[![Checked with flake8](https://img.shields.io/badge/flake8-checked-blue)](http://flake8.pycqa.org/)

[![Checked with pydocstyle](https://img.shields.io/badge/pydocstyle-checked-yellowgreen)](http://www.pydocstyle.org/)

[![Checked with interrogate](https://img.shields.io/badge/interrogate-checked-yellowgreen)](https://interrogate.readthedocs.io/en/latest/)

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.md)

[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)

# Speedtest

> Python wrapper over [Speedtest by Ookla](https://www.speedtest.net) source to test your internet connection bandwidth.

⚠️ _**Note**: project is under construction_

## Tools

### Production

- python 3.6, 3.7, 3.8

### Development

- [travis](https://travis-ci.org/) CI

- [pytest](https://pypi.org/project/pytest/)

- [black](https://black.readthedocs.io/en/stable/)

- [mypy](http://mypy.readthedocs.io/en/latest)

- [pylint](https://www.pylint.org/)

- [flake8](http://flake8.pycqa.org/en/latest/)

- [pydocstyle](https://github.com/PyCQA/pydocstyle)

## Usage

### Quick start

TBD

## Development notes

### Testing

Generally, `pytest` tool is used to organize testing procedure.

Please follow next command to run unittests:

```bash

pytest

```

### CI

Project has Travis CI integration using [.travis.yml](.travis.yml) file thus code analysis (`black`, `pylint`, `flake8`, `mypy`, `pydocstyle` and `interrogate`) and unittests (`pytest`) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

```bash

./analyse-source-code.sh

```

### Release notes

Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.

### Meta

Author – _Volodymyr Yahello_. Please check [authors](AUTHORS.md) file for more details.

Distributed under the `MIT` license. See [license](LICENSE.md) for more information.

You can reach out me at:

* [[email protected]]([email protected])

* [https://twitter.com/vyahello](https://twitter.com/vyahello)

* [https://www.linkedin.com/in/volodymyr-yahello-821746127/](https://www.linkedin.com/in/volodymyr-yahello-821746127/)

### Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps:

1. Clone the repository

2. Configure `git` for the first time after cloning with your `name` and `email`

3. `pip install -r requirements.txt` to install all project dependencies

4. `pip install -r requirements-dev.txt` to install all development project dependencies

5. Create your feature branch (git checkout -b feature/fooBar)

6. Commit your changes (git commit -am 'Add some fooBar')

7. Push to the branch (git push origin feature/fooBar)

8. Create a new Pull Request

### What's next

All recent activities and ideas are described at project [issues](https://github.com/vyahello/speedtest/issues) page. 

If you have ideas you want to change/implement please do not hesitate and create an issue.

**[⬆ back to top](#speedtest)**