Skip to content

Commit 0ef088a

Browse files
committed
doc: update project documentation, added information about checking the project through pylint
1 parent a2fcfb7 commit 0ef088a

File tree

1 file changed

+55
-15
lines changed

1 file changed

+55
-15
lines changed

README.md

Lines changed: 55 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Documentation for check_internrt_speed_application_MacOS
1+
## Documentation for macOS_application_speedtest_for_python
22

33
### Project Description
44

5-
`check_internrt_speed_application_MacOS` is an application designed to check internet
5+
`macOS_application_speedtest_for_python` is an application designed to check internet
66
speed on macOS. It allows users to quickly and conveniently measure download and upload
77
speeds, as well as latency (ping).
88

@@ -18,13 +18,10 @@ To install the dependencies, execute the following commands:
1818

1919
```bash
2020
# Clone repository
21-
# Change directory to the project
22-
cd check_internrt_speed_application_MacOS
23-
21+
git clone https://github.com/AlexTkDev/macOS_application_speedtest_for_python.git
2422
# Create a virtual environment (recommended)
2523
python -m venv .venv
2624
source .venv/bin/activate
27-
2825
# Install dependencies
2926
pip install -r requirements.txt
3027
```
@@ -51,12 +48,34 @@ pyinstaller main.spec
5148
After building, the application will be located in the `dist` directory, and you can launch it by double-clicking the icon.
5249

5350
### Configuration
54-
The project include a `Alexs_SpeedTest.py` file, where you can find settings such as
51+
The project include a `alexs_dpeedtest.py` file, where you can find settings such as
5552
parameters for speed testing. Feel free to modify these parameters according to your needs.
5653

5754
### License
5855
This project is licensed under the MIT License. Please refer to the `LICENSE` file for more detailed information.
5956

57+
### Code Analysis with Pylint
58+
This project uses **Pylint** for static code analysis to ensure that code adheres to Python's
59+
best practices and follows PEP 8 style guidelines. Pylint checks for errors, potential issues,
60+
and enforces consistent coding style, making it a valuable tool for maintaining code quality.
61+
62+
### How to Install Pylint
63+
To install Pylint, use the following command in your terminal:
64+
```bash
65+
pip install pylint
66+
```
67+
### Running Pylint
68+
Once installed, you can run Pylint on a specific Python file with:
69+
```bash
70+
pylint your_file.py
71+
```
72+
Or, to analyze all Python files in the project, run:
73+
```bash
74+
pylint *.py
75+
```
76+
This setup is also configured to run automatically within GitHub Actions on every code push,
77+
checking the code with multiple Python versions for compatibility.
78+
6079
### Contribution
6180
If you would like to contribute to the project, please create a fork of the repository and submit a Pull Request with your changes.
6281

@@ -65,10 +84,10 @@ For questions or suggestions, you can reach out to me via [GitHub](https://githu
6584

6685
***
6786

68-
## Документация к проекту check_internrt_speed_application_MacOS
87+
## Документация к проекту macOS_application_speedtest_for_python
6988

7089
### Описание проекта
71-
`check_internrt_speed_application_MacOS` — это приложение для проверки скорости
90+
`macOS_application_speedtest_for_python` — это приложение для проверки скорости
7291
интернет-соединения на macOS. Оно позволяет пользователям быстро и удобно измерять
7392
скорость загрузки и выгрузки, а также задержку (ping).
7493

@@ -83,13 +102,11 @@ For questions or suggestions, you can reach out to me via [GitHub](https://githu
83102
Для установки зависимостей выполните следующие команды:
84103

85104
```bash
86-
# Переход в каталог проекта
87-
cd check_internrt_speed_application_MacOS
88-
105+
# Клонируйте репозиторий
106+
git clone https://github.com/AlexTkDev/macOS_application_speedtest_for_python.git
89107
# Создание виртуального окружения (рекомендуется)
90108
python -m venv .venv
91109
source .venv/bin/activate
92-
93110
# Установка зависимостей
94111
pip install -r requirements.txt
95112
```
@@ -115,12 +132,35 @@ pyinstaller main.spec
115132
После сборки приложение будет находиться в директории `dist`, и его можно будет запустить двойным щелчком мыши.
116133

117134
### Конфигурация
118-
В проекте файл `Alexs_SpeedTest.py`, в котором находятся настройки, такие как параметры для
135+
В проекте файл `alexs_apeedtest.py`, в котором находятся настройки, такие как параметры для
119136
тестирования скорости. Вы можете изменять эти параметры в соответствии с вашими потребностями.
120137
### Лицензия
121138
Этот проект лицензирован под MIT License. Пожалуйста, ознакомьтесь с файлом `LICENSE` для получения более подробной информации.
122139

123-
### Контрибьюция
140+
### Анализ кода с помощью Pylint
141+
В данном проекте используется **Pylint** для статического анализа кода, чтобы обеспечить
142+
соблюдение лучших практик Python и следование рекомендациям PEP 8. Pylint проверяет наличие
143+
ошибок, потенциальные проблемы и обеспечивает единообразный стиль кода, что делает его ценным
144+
инструментом для поддержания качества кода.
145+
146+
### Как установить Pylint
147+
Для установки Pylint используйте следующую команду в терминале:
148+
```bash
149+
pip install pylint
150+
```
151+
### Запуск Pylint
152+
После установки вы можете запустить Pylint для конкретного Python файла с помощью:
153+
```bash
154+
pylint ваш_файл.py
155+
```
156+
Или, чтобы проанализировать все Python файлы в проекте, выполните:
157+
```bash
158+
pylint *.py
159+
```
160+
Эта настройка также сконфигурирована для автоматического запуска в GitHub Actions при каждом
161+
пуше кода, проверяя код на совместимость с несколькими версиями Python.
162+
163+
### Контрибуция
124164
Если вы хотите внести свой вклад в проект, пожалуйста, создайте форк репозитория и отправьте Pull Request с вашими изменениями.
125165

126166
### Связь

0 commit comments

Comments
 (0)