Skip to content

Commit f596f9e

Browse files
docs: Added README."en".md translation via https://github.com/dephraiim/translate-readme
1 parent e46bf50 commit f596f9e

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.en.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Python Utils
2+
3+
- [Simplified Chinese](README.md)
4+
- [English](README.en.md)
5+
6+
Collection of gadgets that make development and life happier 🧰
7+
8+
## 📦 Tool list
9+
10+
| Module | describe | Main Documents |
11+
| ----------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
12+
| **cli_logger** | loguru log configuration example, console + file dual channel output | [`cli_logger.py`](cli_logger/cli_logger.py) |
13+
| **youwatch** | Real-time monitoring of folder changes (add/delete/modify/rename) | [`dirwatch.py`](dirwatch/dirwatch.py) |
14+
| **hash** | Calculate the hash value of a file or text (MD5/SHA-1/SHA-2/SHA-3/BLAKE2/BLAKE3) | [`hash.py`](hash/hash.py) |
15+
| **image-toolkit** | Universal image conversion + generate macOS/Windows application icons with one click (`.icns`/`.ico`| [`convert_img.py`](image-toolkit/convert_img.py)/[`make_icns.py`](image-toolkit/make_icns.py)/[`make_ico.py`](image-toolkit/make_ico.py) |
16+
| **m3u8_download** | m3u8 downloader, automatically merge ts into a single video | [`m3u8_dl.py`](m3u8_download/m3u8_dl.py) |
17+
| **Procmon** | Real-time monitoring of CPU/memory/thread/handle by process name | [`procmon.py`](procmon/procmon.py) |
18+
| **resolve** | Domain name resolution tool to quickly obtain IP, port, and protocol information | [`resolve.py`](resolve/resolve.py) |
19+
| **syncthing** | Syncthing API encapsulation, monitoring folder and device status | [`syncthing_monitor.py`](syncthing/syncthing_monitor.py) |
20+
| **tree** | Visual directory tree generation tool | [`tree.py`](tree/tree.py) |
21+
| **utils** | General Tool Library (Color Output, etc.) | [`colors.py`](utils/colors.py) |
22+
| **sync_req** | Relying on the synchronization tool, generate requirements.txt from pyproject.toml | [`sync_req.py`](sync_req.py) |
23+
24+
## 🚀 Quick start
25+
26+
### Installation dependencies
27+
28+
Recommended use of virtual environments:
29+
30+
```bash
31+
# 创建虚拟环境
32+
python -m venv venv
33+
34+
# 激活虚拟环境 (Linux/macOS)
35+
source venv/bin/activate
36+
37+
# 或使用提供的脚本激活
38+
source activate_venv.sh
39+
40+
# 安装依赖
41+
pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
42+
```
43+
44+
### Synchronize dependency files
45+
46+
Project provided`sync_req.py`Tools for`pyproject.toml`generate`requirements.txt`
47+
48+
```bash
49+
# 生成 requirements.txt
50+
python sync_req.py
51+
52+
# 使用生成的 requirements.txt 安装依赖
53+
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
54+
```
55+
56+
### Instructions for use
57+
58+
👉 Direct`cd`Enter the corresponding directory,`python xxx.py -h`You can start playing!

0 commit comments

Comments
 (0)