|
1 | | -# PyHelper - A packages that provide more helper tools for Python |
| 1 | +# PyHelper - A Package Providing Additional Utility Tools for Python |
2 | 2 |
|
3 | 3 | [Chinese Version - 中文版本](README-chinese.md) |
4 | 4 |
|
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 | | - |
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 | | - |
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 https://github.com/nanocode38/pyhelper.git |
0 commit comments