Skip to content

Commit e13d315

Browse files
committed
doc: updated documentation
1 parent ef03110 commit e13d315

1 file changed

Lines changed: 50 additions & 30 deletions

File tree

README.md

Lines changed: 50 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
### Project Description
44

5-
`macOS_application_speedtest_for_python` is an application for testing internet connection
6-
speed on macOS. It allows users to quickly and easily measure download and upload speeds, latency (ping), as well as the history of speed measurements.
7-
The project also provides system information, including the computer name, network adapters, their IP addresses, and MAC addresses, displayed directly in the program window.
5+
`macOS_application_speedtest_for_python` is a macOS application designed to test your internet connection
6+
speed using Python. The program provides a convenient interface for measuring download, upload, and ping speeds,
7+
and also supports retesting and viewing test history.
88
The project is built based on another one of my applications, which you can check out on GitHub:
99
[Internet Speed Test](https://github.com/AlexTkDev/different_mini-apps/tree/main/check_internrt_speed)
1010

@@ -31,21 +31,28 @@ pip install -r requirements.txt
3131
### Usage
3232
After installation, you can run the application by executing:
3333
```bash
34-
python main.py
34+
python alexs_speedtest.py
3535
```
3636

37-
#### Application Interface
38-
The application features a simple and intuitive interface where you can view:
39-
- **Download Speed**
40-
- **Upload Speed**
41-
- **Ping**
42-
- **Adapter**
43-
- **IP Address**
44-
- **MAC Address**
45-
- **View Test History table**
46-
- **Show graph Test History**
37+
#### Features
38+
- **Internet Speed Measurement**: The app allows you to test download and upload speeds, as well as ping (latency) of your internet connection.
39+
- **Graphical Display**: After completing a test, users can view the test results and optionally plot the test history.
40+
- **Repeat Test**: After a test is completed, users can repeat the test without needing to restart the application.
41+
- **Test History**: The app saves the results of previous tests, allowing users to view the test history and visualize changes in speed.
42+
43+
#### Key Components
44+
- **Tkinter**: Used for creating the graphical user interface (GUI), which includes buttons for starting tests, viewing results, and plotting graphs.
45+
- **Speedtest-cli**: A library for performing internet speed tests, which powers the app's functionality.
46+
- **Matplotlib**: A library for visualizing the test history by plotting graphs.
47+
- **JSON**: A library for reading and writing test results stored in JSON format.
48+
49+
#### How It Works
50+
1. When the app is launched, users can click the **"Start Speed Test"** button to initiate the test.
51+
2. The app runs a speed test using the **speedtest-cli** library, measuring download speed, upload speed, and ping.
52+
3. Once the test is completed, the results are displayed in the app's interface.
53+
4. Users can save the test results to the **history.json** file and visualize the data using **matplotlib**.
54+
5. For a repeat test, users can simply click the **"Repeat Speed Test"** button, which hides the history buttons until the new test is finished.
4755

48-
When the application is launched, it will automatically begin testing internet speed.
4956

5057
#### Building the Application
5158
To build the application in `.app` format, run the following command:
@@ -94,10 +101,9 @@ For questions or suggestions, you can reach out to me via [GitHub](https://githu
94101
## Документация к проекту macOS_application_speedtest_for_python
95102

96103
### Описание проекта
97-
`macOS_application_speedtest_for_python` — это приложение для проверки скорости
98-
интернет-соединения на macOS. Оно позволяет пользователям быстро и удобно измерять скорость
99-
загрузки и выгрузки, задержку (ping), а также истории замеров скорости.
100-
В проекте также представлена информация о системе, включая название компьютера, сетевые адаптеры, их IP-адреса и MAC-адреса, отображаемая прямо в окне программы.
104+
`macOS_application_speedtest_for_python` — это приложение для macOS, предназначенное для проверки
105+
скорости интернет-соединения с использованием Python. Программа предоставляет удобный интерфейс для измерения
106+
скорости загрузки, выгрузки и пинга, а также поддерживает повторные тесты и просмотр истории тестов.
101107
Проект разработан на основе другого моего приложения, которое вы можете посмотреть по ссылке на GitHub:
102108
[Internet Speed Test](https://github.com/AlexTkDev/different_mini-apps/tree/main/check_internrt_speed)
103109

@@ -124,19 +130,33 @@ pip install -r requirements.txt
124130
### Использование
125131
После установки вы можете запустить приложение, выполнив команду:
126132
```bash
127-
python main.py
133+
python alexs_speedtest.py
128134
```
129135

130-
#### Интерфейс приложения
131-
Приложение имеет простой и интуитивно понятный интерфейс, где вы можете увидеть:
132-
- **Скорость загрузки** (Download Speed)
133-
- **Скорость выгрузки** (Upload Speed)
134-
- **Задержка** (Ping)
135-
- **Адаптер** (Adapter)
136-
- **IP Адрес** (IP Address)
137-
- **MAC Адрес** (MAC Address)
138-
- **Показать таблицу истории** (View Test History table)
139-
- **Показать график измерений** (Show graph Test History)
136+
#### Возможности
137+
- **Измерение скорости интернета**: Приложение позволяет проверить скорость загрузки и выгрузки данных, а также пинг вашего интернет-соединения.
138+
- **Графическое отображение**: После завершения теста пользователи могут увидеть результаты теста в наглядной форме, а также построить график истории тестов.
139+
- **Повторный тест**: После завершения теста пользователи могут повторно запустить тест без необходимости перезапуска приложения.
140+
- **История тестов**: Приложение сохраняет результаты предыдущих тестов, предоставляя возможность просматривать историю тестов и визуализировать изменения скорости интернета.
141+
142+
#### Основные компоненты
143+
- **Tkinter**: Используется для создания графического интерфейса пользователя (GUI), где отображаются кнопки для запуска теста, результатов и графиков.
144+
- **Speedtest-cli**: Библиотека для проведения тестов скорости интернет-соединения, на основе которой работает приложение.
145+
- **Matplotlib**: Используется для построения графиков истории тестов.
146+
147+
#### Используемые библиотеки
148+
- **Tkinter**: Стандартная библиотека Python для создания графических интерфейсов.
149+
- **speedtest-cli**: Библиотека для проведения тестов скорости интернета.
150+
- **matplotlib**: Библиотека для визуализации данных, используется для построения графиков.
151+
- **json**: Библиотека для работы с форматами данных JSON, используется для сохранения и загрузки истории тестов.
152+
153+
#### Как это работает
154+
1. При запуске приложения пользователь может нажать кнопку **"Start Speed Test"**, чтобы начать тестирование скорости интернет-соединения.
155+
2. Приложение запускает тест с использованием библиотеки **speedtest-cli**, который измеряет скорость загрузки, выгрузки и пинг.
156+
3. После завершения теста результаты отображаются в окне приложения.
157+
4. Пользователь может сохранить результаты тестов в файл **history.json**, а также построить график с помощью библиотеки **matplotlib**.
158+
5. Для повторного теста достаточно нажать на кнопку **"Repeat Speed Test"**, и тест будет выполнен снова, скрыв кнопки истории до окончания нового теста.
159+
140160

141161
При запуске приложения оно автоматически начнет тестирование скорости интернета.
142162
#### Сборка приложения

0 commit comments

Comments
 (0)