Skip to content

Commit e0ecab6

Browse files
committed
Update README.md
1 parent 1469eb3 commit e0ecab6

File tree

2 files changed

+105
-36
lines changed

2 files changed

+105
-36
lines changed

README-chinese.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,61 @@
33

44
[英文版本 - English Version](README.md)
55

6-
这是一个为Python提供更多辅助工具的包
6+
PyHelper是补充Python和Pygame开发的强大工具集。增强你与我们的实用工具和帮助者的编码经验。
7+
8+
## 为什么选择PyHelper?
9+
PyHelper精简了Python和Pygame的开发,提供了一套全面的实用工具,旨在:
10+
- 加速开发时间
11+
- 简化复杂任务
12+
- 增强代码性能
13+
- 降低样板代码
714

815
## 下载包
16+
这个包已经发布到了PyPI, 所以可以直接使用pip安装
917

10-
此包暂时没有发布到PyPi(由于名称重名),因此无法使用pip直接下载安装。必须手动下载whl包并安装
18+
Windows下使用命令:
19+
```commandline
20+
python -m pip install nanocode38-pyhelper
21+
```
1122

12-
首先登录[Github](https://github.com/), 来的[Pyhelper官方网站](https://github.com/pyhelper.git), 然后找到```Releases```一栏,
13-
点击下面的发行版。如图。
14-
![img.png](img.png)
23+
类UNIX系统下使用命令:
24+
```bash
25+
pip3 install nanocode38-pyhelper
26+
```
1527

16-
然后在```Assets```栏中下载``pyhelper-2.1.0-py2.py3-none-any.whl```, 名称可能因版本而不同, 但一点要以.whl结尾
17-
如图。
28+
在虚拟环境中直接使用pip即可。记得先激活虚拟环境!
29+
```commandline
30+
pip install nanocde38-pyhelper
31+
```
1832

19-
![img_1.png](img_1.png)
33+
为检查是否安装成功, 可以使用Python来试图导入:
34+
```bash
35+
$ python
36+
Python 3.13.5 (tags/v3.13.5:6cb20a2, Jun 11 2025, 16:15:46) [MSC v.1943 64 bit (AMD64)] on win32
37+
Type "help", "copyright", "credits" or "license" for more information.
38+
>>> import pyhelper
39+
PyHelper 2.6.1 (Microsoft Windows, Python 3.13.5)
40+
Hello from the PyHelper community! https://githun.com/nanocode38/pyhelper.git
41+
>>>
42+
```
43+
*注: 您导入过程中打印的提示取决于您使用的Python版本和PyHelper版本, 也许和这里展示的不太一样*
2044

21-
下载完成后切换到含有whl文件的目录,运行```pip3 install [Whl文件]```, 把[Whl文件]替换为下载的whl文件名称
45+
如果安装失败, 导入也会失败:
46+
```bash
47+
$ python
48+
Python 3.13.5 (tags/v3.13.5:6cb20a2, Jun 11 2025, 16:15:46) [MSC v.1943 64 bit (AMD64)] on win32
49+
Type "help", "copyright", "credits" or "license" for more information.
50+
>>> import pyhelper
51+
Traceback (most recent call last):
52+
File "<python-input-0>", line 1, in <module>
53+
import pyhelper
54+
ModuleNotFoundError: No module named 'pyhelper'
55+
>>>
56+
```
2257

23-
*注:若需要在虚拟环境中安装, 记得提前激活虚拟环境!*
58+
## 为什么叫nanocode38-pyhelper而不是pyhelper?
59+
PyPI自2023年以来拒绝发布与现有项目名称视觉/拼写相似度过高的新包名(即使不完全相同),目的是防止仿冒包和用户混淆。在PyPI上已经有了PyHelper以及与PythonHelper类似的包, 所以采用主要开发者名-包名的方式发布, 但是导入是请依然使用pyhelper
2460

25-
这就完成了!
2661

2762
## 贡献
2863

README.md

Lines changed: 59 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,62 @@
1-
# PyHelper - A packages that provide more helper tools for Python
1+
# PyHelper - A Package Providing Additional Utility Tools for Python
22

33
[Chinese Version - 中文版本](README-chinese.md)
44

5-
This is a Packages that provide more helper tools for Python
6-
7-
## Downloading packages
8-
9-
This package has not yet been published to PyPi(because the name is the same),
10-
so the whl package must be downloaded and installed manually
11-
12-
To log in first [GitHub](https://github.com/), the [Pyhelper official website](https://github.com/pyhelper.git), and then find a ` ` ` Releases ` ` ` column,
13-
Click on the distribution below.
14-
![](assets/img.png)
15-
16-
Then under Assets, download pyhelper-2.1.0-py2.py3-none-any.whl. The name may vary from version to version, but it should end with.whl
17-
18-
![](assets/img_1.png)
19-
20-
Once the download is complete, switch to the directory containing the whl file and run pip3 install [Whl file], replacing [Whl file] with the name of the whl file you downloaded
21-
22-
*Note: If you need to install in a virtual environment, remember to activate the virtual environment in advance!*
23-
24-
And that's it!
25-
26-
## Ontribution
27-
28-
If you want to contribute to PyHelper, see https://github.com/nanocode38/pyhelper.git
5+
PyHelper is a powerful toolkit that complements Python and Pygame development. It enhances your coding experience with our practical utilities and helpers.
6+
7+
## Why Choose PyHelper?
8+
PyHelper streamlines Python and Pygame development by providing a comprehensive set of utility tools designed to:
9+
- Accelerate development time
10+
- Simplify complex tasks
11+
- Enhance code performance
12+
- Reduce boilerplate code
13+
14+
## Download the Package
15+
This package has been published to PyPI, so you can install it directly using pip.
16+
17+
For Windows, use the following command:
18+
```commandline
19+
python -m pip install nanocode38-pyhelper
20+
```
21+
22+
For UNIX-like systems, use the command:
23+
```bash
24+
pip3 install nanocode38-pyhelper
25+
```
26+
27+
In a virtual environment, you can directly use pip. Remember to activate the virtual environment first!
28+
```commandline
29+
pip install nanocde38-pyhelper
30+
```
31+
32+
To check if the installation was successful, you can try importing it with Python:
33+
```bash
34+
$ python
35+
Python 3.13.5 (tags/v3.13.5:6cb20a2, Jun 11 2025, 16:15:46) [MSC v.1943 64 bit (AMD64)] on win32
36+
Type "help", "copyright", "credits" or "license" for more information.
37+
>>> import pyhelper
38+
PyHelper 2.6.1 (Microsoft Windows, Python 3.13.5)
39+
Hello from the PyHelper community! https://githun.com/nanocode38/pyhelper.git
40+
>>>
41+
```
42+
*Note: The prompt printed during import may vary depending on your Python version and PyHelper version, and might not exactly match what is shown here.*
43+
44+
If the installation fails, the import will also fail:
45+
```bash
46+
$ python
47+
Python 3.13.5 (tags/v3.13.5:6cb20a2, Jun 11 2025, 16:15:46) [MSC v.1943 64 bit (AMD64)] on win32
48+
Type "help", "copyright", "credits" or "license" for more information.
49+
>>> import pyhelper
50+
Traceback (most recent call last):
51+
File "<python-input-0>", line 1, in <module>
52+
import pyhelper
53+
ModuleNotFoundError: No module named 'pyhelper'
54+
>>>
55+
```
56+
57+
## Why Is It Called nanocode38-pyhelper Instead of pyhelper?
58+
Since 2023, PyPI has rejected the publication of new package names that are visually or spelling-wise too similar to existing projects (even if not identical), aiming to prevent imitation packages and user confusion. Since PyHelper and PythonHelper-like packages already exist on PyPI, the package is published under the format of "main developer name-package name," but you should still use `import pyhelper` for importing.
59+
60+
## Contribution
61+
62+
If you'd like to contribute to PyHelper, please visit on [GitHub](https://github.com/nanocode38/pyhelper.git)

0 commit comments

Comments
 (0)