Skip to content

Commit b0bc4b7

Browse files
FarmerokFarmerok
committed
init readme.md
1 parent 3c3dd57 commit b0bc4b7

File tree

2 files changed

+246
-0
lines changed

2 files changed

+246
-0
lines changed

‎docs/README.en.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# 🖥️ **EasyAdmin** - Windows Management with Commands
2+
3+
**EasyAdmin** is a convenient tool for managing the Windows system using simple commands. With it, you can control power, sound, processes, network, and many other aspects of the system. This tool is perfect for both task automation and quick command execution.
4+
5+
In this guide, you will learn how to use **EasyAdmin** in Python or directly via the command line to perform various operations.
6+
7+
---
8+
9+
## 🚀 **How to Use EasyAdmin in Python?**
10+
11+
To integrate **EasyAdmin** into your Python project, simply call it via the command line using the `subprocess` module. Follow the steps below to get started.
12+
13+
### 1️⃣ **Preparation**
14+
15+
1. Download **EasyAdmin** and place it in your project folder or any location accessible from the command line. For example, you can place it in the folder `C:\Tools\EasyAdmin`.
16+
2. Ensure the path to **EasyAdmin** is added to the `PATH` environment variable, or use the full path when calling it.
17+
18+
### 2️⃣ **Import the subprocess Module**
19+
20+
To execute commands from Python, use the standard `subprocess` module. This module allows you to run commands in the command line directly from a Python script.
21+
22+
### 3️⃣ **Code Example**
23+
24+
Create a function for convenient execution of **EasyAdmin** commands:
25+
26+
```python
27+
import subprocess
28+
29+
def run_easyadmin(command, param=""):
30+
"""
31+
Executes an EasyAdmin command via the command line.
32+
33+
:param command: The command to execute (e.g., 'volumemute').
34+
:param param: An additional parameter for the command (e.g., 'off').
35+
"""
36+
command_str = f"EasyAdmin.exe {command} {param}" if param else f"EasyAdmin.exe {command}"
37+
try:
38+
subprocess.run(command_str, shell=True, check=True)
39+
except subprocess.CalledProcessError as e:
40+
print(f"Command execution error: {e}")
41+
```
42+
43+
#### Usage Examples:
44+
45+
- **Mute Sound** 🔇:
46+
```python
47+
run_easyadmin("volumemute")
48+
```
49+
50+
- **Disable Wi-Fi** 🌐:
51+
```python
52+
run_easyadmin("wifi", "off")
53+
```
54+
55+
- **Reboot Computer** 🔄:
56+
```python
57+
run_easyadmin("reboot")
58+
```
59+
60+
---
61+
62+
## 💻 **Using EasyAdmin Without Python (via Command Line)**
63+
64+
If you are not using Python, you can call **EasyAdmin** directly from the command line (CMD). This is especially useful for quick task execution.
65+
66+
### Command Examples:
67+
68+
- **Decrease Volume** 🔉:
69+
```console
70+
EasyAdmin.exe volumedown
71+
```
72+
73+
- **Increase Volume** 🔊:
74+
```console
75+
EasyAdmin.exe volumeup
76+
```
77+
78+
- **Shut Down Computer** 🖥️:
79+
```console
80+
EasyAdmin.exe shutdown
81+
```
82+
83+
---
84+
85+
## 📜 **List of Available Commands**
86+
87+
| Command | Description |
88+
|--------------------------------|---------------------------------------------------------------------------------------------|
89+
| `lockscreen` | Lock the screen |
90+
| `volumedown` | Decrease volume |
91+
| `volumeup` | Increase volume |
92+
| `volumemute` | Mute sound |
93+
| `nexttrack` | Next track |
94+
| `prevtrack` | Previous track |
95+
| `playpause` | Play/Pause |
96+
| `monitoroff` | Turn off the monitor |
97+
| `standby` | Put the system into standby mode |
98+
| `logoff` | Log off the user account |
99+
| `reboot` | Reboot the system |
100+
| `shutdown` | Shut down the system |
101+
| `kill <process>` | Terminate a process by name |
102+
| `killpid <PID>` | Terminate a process by PID |
103+
| `killnotresp` | Terminate unresponsive processes |
104+
| `cdrom <drive> open|close` | Open/Close the CD-ROM |
105+
| `brightness <0-100>` | Set screen brightness |
106+
| `wifi <on|off>` | Enable or disable Wi-Fi |
107+
| `sysinfo` | Display system information |
108+
| `open <path>` | Open a program |
109+
110+
---
111+
112+
## 🛠️ **Helpful Tips**
113+
1. **Task Automation**: You can use **EasyAdmin** in scripts to automate routine tasks, such as power or network management.
114+
115+
2. **Security**: Ensure you download **EasyAdmin** only from trusted sources to avoid malicious software.
116+
117+
---
118+
119+
## 📚 **Conclusion**
120+
121+
**EasyAdmin** is an open-source tool for Windows management that can be used in Python scripts or directly via the command line. It simplifies routine tasks and allows for system management automation.
122+
123+
Try **EasyAdmin** today and make your Windows experience easier and more convenient! 🚀

‎docs/README.ru.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# 🖥️ **EasyAdmin** - Управление Windows с помощью команд
2+
3+
**EasyAdmin** — это удобный инструмент для управления системой Windows с помощью простых команд. С его помощью вы можете управлять питанием, звуком, процессами, сетью и многими другими аспектами системы. Этот инструмент идеально подходит как для автоматизации задач, так и для быстрого выполнения команд.
4+
5+
В этом руководстве вы узнаете, как использовать **EasyAdmin** в Python или напрямую через командную строку для выполнения различных операций.
6+
7+
---
8+
9+
## 🚀 **Как использовать EasyAdmin в Python?**
10+
11+
Чтобы интегрировать **EasyAdmin** в ваш Python-проект, достаточно вызывать его через командную строку с использованием модуля `subprocess`. Следуйте шагам ниже, чтобы начать.
12+
13+
### 1️⃣ **Подготовка**
14+
15+
1. Скачайте **EasyAdmin** и поместите его в папку с вашим проектом или в любое место, доступное из командной строки. Например, вы можете разместить его в папке `C:\Tools\EasyAdmin`.
16+
2. Убедитесь, что путь к **EasyAdmin** добавлен в переменную окружения `PATH`, либо используйте полный путь при вызове.
17+
18+
### 2️⃣ **Импорт модуля subprocess**
19+
20+
Для выполнения команд из Python используйте стандартный модуль `subprocess`. Этот модуль позволяет запускать команды в командной строке прямо из Python-скрипта.
21+
22+
### 3️⃣ **Пример кода**
23+
24+
Создайте функцию для удобного вызова команд **EasyAdmin**:
25+
26+
```python
27+
import subprocess
28+
29+
def run_easyadmin(command, param=""):
30+
"""
31+
Выполняет команду EasyAdmin через командную строку.
32+
33+
:param command: Команда для выполнения (например, 'volumemute').
34+
:param param: Дополнительный параметр команды (например, 'off').
35+
"""
36+
command_str = f"EasyAdmin.exe {command} {param}" if param else f"EasyAdmin.exe {command}"
37+
try:
38+
subprocess.run(command_str, shell=True, check=True)
39+
except subprocess.CalledProcessError as e:
40+
print(f"Ошибка выполнения команды: {e}")
41+
```
42+
43+
#### Примеры использования:
44+
45+
- **Отключение звука** 🔇:
46+
```python
47+
run_easyadmin("volumemute")
48+
```
49+
50+
- **Отключение Wi-Fi** 🌐:
51+
```python
52+
run_easyadmin("wifi", "off")
53+
```
54+
55+
- **Перезагрузка компьютера** 🔄:
56+
```python
57+
run_easyadmin("reboot")
58+
```
59+
60+
---
61+
62+
## 💻 **Использование EasyAdmin без Python (через командную строку)**
63+
64+
Если вы не используете Python, вы можете вызывать **EasyAdmin** напрямую из командной строки (CMD). Это особенно полезно для быстрого выполнения задач.
65+
66+
### Примеры команд:
67+
68+
- **Уменьшение громкости** 🔉:
69+
```console
70+
EasyAdmin.exe volumedown
71+
```
72+
73+
- **Увеличение громкости** 🔊:
74+
```console
75+
EasyAdmin.exe volumeup
76+
```
77+
78+
- **Выключение компьютера** 🖥️:
79+
```console
80+
EasyAdmin.exe shutdown
81+
```
82+
83+
---
84+
85+
## 📜 **Список доступных команд**
86+
87+
| Команда | Описание |
88+
|--------------------------------|----------------------------------------------------------------------------------------------|
89+
| `lockscreen` | Заблокировать экран |
90+
| `volumedown` | Уменьшить громкость |
91+
| `volumeup` | Увеличить громкость |
92+
| `volumemute` | Отключить звук |
93+
| `nexttrack` | Следующий трек |
94+
| `prevtrack` | Предыдущий трек |
95+
| `playpause` | Воспроизведение/Пауза |
96+
| `monitoroff` | Выключить монитор |
97+
| `standby` | Перевести систему в режим ожидания |
98+
| `logoff` | Выйти из учетной записи |
99+
| `reboot` | Перезагрузить систему |
100+
| `shutdown` | Выключить систему |
101+
| `kill <process>` | Завершить процесс по имени |
102+
| `killpid <PID>` | Завершить процесс по PID |
103+
| `killnotresp` | Завершить неотвечающие процессы |
104+
| `cdrom <drive> open|close` | Открыть/Закрыть CD-ROM |
105+
| `brightness <0-100>` | Установить яркость экрана |
106+
| `wifi <on|off>` | Включить или отключить Wi-Fi |
107+
| `sysinfo` | Показать информацию о системе |
108+
| `open <path>` | Открыть программу |
109+
110+
---
111+
112+
## 🛠️ **Полезные советы**
113+
1. **Автоматизация задач**: Вы можете использовать **EasyAdmin** в скриптах для автоматизации рутинных задач, таких как управление питанием или сетью.
114+
115+
2. **Безопасность**: Убедитесь, что вы скачиваете **EasyAdmin** только из доверенных источников, чтобы избежать вредоносного ПО.
116+
117+
---
118+
119+
## 📚 **Заключение**
120+
121+
**EasyAdmin** — это инструмент с открытым исходным кодом для управления Windows, который можно использовать как в Python-скриптах, так и напрямую через командную строку. Он упрощает выполнение рутинных задач и позволяет автоматизировать управление системой.
122+
123+
Попробуйте **EasyAdmin** уже сегодня и сделайте свою работу с Windows проще и удобнее! 🚀

0 commit comments

Comments
 (0)