Skip to content

Commit 79ccb5d

Browse files
authored
Update README.md
1 parent 73e2b26 commit 79ccb5d

File tree

1 file changed

+0
-104
lines changed

1 file changed

+0
-104
lines changed

README.md

Lines changed: 0 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -95,107 +95,3 @@ If you would like to contribute to the project, please create a fork of the repo
9595
### Contact
9696
For questions or suggestions, you can reach out to me via [GitHub](https://github.com/AlexTkDev).
9797

98-
***
99-
100-
## Документация к проекту macOS_application_speedtest_for_python
101-
102-
### Описание проекта
103-
`macOS_application_speedtest_for_python` — это приложение для macOS, предназначенное для проверки
104-
скорости интернет-соединения с использованием Python. Программа предоставляет удобный интерфейс для измерения
105-
скорости загрузки, выгрузки и пинга, а также поддерживает повторные тесты и просмотр истории тестов.
106-
Проект разработан на основе другого моего приложения, которое вы можете посмотреть по ссылке на GitHub:
107-
[Internet Speed Test](https://github.com/AlexTkDev/different_mini-apps/tree/main/check_internrt_speed)
108-
109-
### Установка
110-
111-
#### Системные требования
112-
- macOS (версия 10.14 и выше)
113-
- Python 3.6 или выше
114-
- Установленные зависимости, перечисленные в `requirements.txt`
115-
116-
#### Установка зависимостей
117-
Для установки зависимостей выполните следующие команды:
118-
119-
```bash
120-
# Клонируйте репозиторий
121-
git clone https://github.com/AlexTkDev/macOS_application_speedtest_for_python.git
122-
# Создание виртуального окружения (рекомендуется)
123-
python -m venv .venv
124-
source .venv/bin/activate
125-
# Установка зависимостей
126-
pip install -r requirements.txt
127-
```
128-
129-
### Использование
130-
После установки вы можете запустить приложение, выполнив команду:
131-
```bash
132-
python alexs_speedtest.py
133-
```
134-
135-
#### Возможности
136-
- **Измерение скорости интернета**: Приложение позволяет проверить скорость загрузки и выгрузки данных, а также пинг вашего интернет-соединения.
137-
- **Графическое отображение**: После завершения теста пользователи могут увидеть результаты теста в наглядной форме, а также построить график истории тестов.
138-
- **Повторный тест**: После завершения теста пользователи могут повторно запустить тест без необходимости перезапуска приложения.
139-
- **История тестов**: Приложение сохраняет результаты предыдущих тестов, предоставляя возможность просматривать историю тестов и визуализировать изменения скорости интернета.
140-
141-
#### Основные компоненты
142-
- **Tkinter**: Используется для создания графического интерфейса пользователя (GUI), где отображаются кнопки для запуска теста, результатов и графиков.
143-
- **Speedtest-cli**: Библиотека для проведения тестов скорости интернет-соединения, на основе которой работает приложение.
144-
- **Matplotlib**: Используется для построения графиков истории тестов.
145-
146-
#### Используемые библиотеки
147-
- **Tkinter**: Стандартная библиотека Python для создания графических интерфейсов.
148-
- **speedtest-cli**: Библиотека для проведения тестов скорости интернета.
149-
- **matplotlib**: Библиотека для визуализации данных, используется для построения графиков.
150-
- **json**: Библиотека для работы с форматами данных JSON, используется для сохранения и загрузки истории тестов.
151-
152-
#### Как это работает
153-
1. При запуске приложения пользователь может нажать кнопку **"Start Speed Test"**, чтобы начать тестирование скорости интернет-соединения.
154-
2. Приложение запускает тест с использованием библиотеки **speedtest-cli**, который измеряет скорость загрузки, выгрузки и пинг.
155-
3. После завершения теста результаты отображаются в окне приложения.
156-
4. Пользователь может сохранить результаты тестов в файл **history.json**, а также построить график с помощью библиотеки **matplotlib**.
157-
5. Для повторного теста достаточно нажать на кнопку **"Repeat Speed Test"**, и тест будет выполнен снова, скрыв кнопки истории до окончания нового теста.
158-
159-
160-
При запуске приложения оно автоматически начнет тестирование скорости интернета.
161-
#### Сборка приложения
162-
Для сборки приложения в формате `.app`, выполните следующую команду:
163-
```bash
164-
pyinstaller main.spec
165-
```
166-
После сборки приложение будет находиться в директории `dist`, и его можно будет запустить двойным щелчком мыши.
167-
168-
### Конфигурация
169-
В проекте файл `alexs_speedtest.py`, в котором находятся настройки, такие как параметры для
170-
тестирования скорости. Вы можете изменять эти параметры в соответствии с вашими потребностями.
171-
### Лицензия
172-
Этот проект лицензирован под MIT License. Пожалуйста, ознакомьтесь с файлом `LICENSE` для получения более подробной информации.
173-
174-
### Анализ кода с помощью Pylint
175-
В данном проекте используется **Pylint** для статического анализа кода, чтобы обеспечить
176-
соблюдение лучших практик Python и следование рекомендациям PEP 8. Pylint проверяет наличие
177-
ошибок, потенциальные проблемы и обеспечивает единообразный стиль кода, что делает его ценным
178-
инструментом для поддержания качества кода.
179-
180-
### Как установить Pylint
181-
Для установки Pylint используйте следующую команду в терминале:
182-
```bash
183-
pip install pylint
184-
```
185-
### Запуск Pylint
186-
После установки вы можете запустить Pylint для конкретного Python файла с помощью:
187-
```bash
188-
pylint ваш_файл.py
189-
```
190-
Или, чтобы проанализировать все Python файлы в проекте, выполните:
191-
```bash
192-
pylint *.py
193-
```
194-
Эта настройка также сконфигурирована для автоматического запуска в GitHub Actions при каждом
195-
пуше кода, проверяя код на совместимость с несколькими версиями Python.
196-
197-
### Контрибуция
198-
Если вы хотите внести свой вклад в проект, пожалуйста, создайте форк репозитория и отправьте Pull Request с вашими изменениями.
199-
200-
### Связь
201-
Для вопросов или предложений вы можете связаться со мной через [GitHub](https://github.com/AlexTkDev).

0 commit comments

Comments
 (0)