Skip to content

Welcome to Yspeed Documentation

Yspeed is a Python tool for testing internet speed using the https://www.speedtest.net/ service. It provides information on download speed, upload speed, ping, operator, IP address, location, and best server for the connection.

Getting Started

To get started with Yspeed, you can clone the GitHub repository and install the required dependencies using pip:

1
2
3
git clone https://github.com/your_username/yspeed.git
cd yspeed
pip install -r requirements.txt

or

pip install yspeed

Usage

To use Yspeed, you can run the yspeed.py script using the following command:

python yspeed.py

This will start the speed test and display the results in the console.

Documentation

This documentation provides information on how to use Yspeed, including installation, usage, and customization. You can navigate through the documentation using the sidebar on the left.

Contributing

If you would like to contribute to Yspeed, you can clone the GitHub repository, create a new branch for your feature or bug fix, make the necessary changes, and submit a pull request.

License

Yspeed is distributed under the MIT license. See the LICENSE file for more information.

We hope you enjoy using Yspeed to test your internet speed!

Last update: April 10, 2023
Created: April 10, 2023