Skip to content

Commit 7fd4831

Browse files
docs: Added README."en".md translation via https://github.com/dephraiim/translate-readme
1 parent 293c689 commit 7fd4831

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.en.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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+
| **icon-maker** | Generate macOS/Windows application icons with one click (`.icns`/`.ico`| [`make_icns.py`](icon-maker/make_icns.py)/[`make_ico.py`](icon-maker/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+
| **webDav** | Lightweight WebDAV client, supports upload/download/delete/mobile | [`webdav.py`](webdav/webdav.py) |
23+
| **sync_req** | Relying on the synchronization tool, generate requirements.txt from pyproject.toml | [`sync_req.py`](sync_req.py) |
24+
25+
## 🚀 Quick start
26+
27+
### Installation dependencies
28+
29+
Recommended use of virtual environments:
30+
31+
```bash
32+
# 创建虚拟环境
33+
python -m venv venv
34+
35+
# 激活虚拟环境 (Linux/macOS)
36+
source venv/bin/activate
37+
38+
# 或使用提供的脚本激活
39+
source activate_venv.sh
40+
41+
# 安装依赖
42+
pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
43+
```
44+
45+
### Synchronize dependency files
46+
47+
Project provided`sync_req.py` 工具,用于从 `pyproject.toml`generate`requirements.txt`
48+
49+
```bash
50+
# 生成 requirements.txt
51+
python sync_req.py
52+
53+
# 使用生成的 requirements.txt 安装依赖
54+
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
55+
```
56+
57+
### Instructions for use
58+
59+
👉 Direct`cd`Enter the corresponding directory,`python xxx.py -h`You can start playing!

0 commit comments

Comments
 (0)