My PyPI Package Project

A sample project to create a Python package and publish it to PyPI. https://pypi.tw.martin98.com/project/hanbin-hello/

Credit to https://www.youtube.com/watch?v=Kz6IlDCyOUY

Setting Up

To set up your Python environment for publishing your own package, you will need to install setuptools, wheel, and twine.

You can install these tools using pip:

pip install -r requirements.txt

This provides a cleaner and more straightforward way for users to interact with your package, as they can simply use from hanbin_hello import hello instead of navigating through deeper module structures.

from hanbin_hello import hello

In this example, replace 'your-package-name' with the actual name of your package. The version field should be set to the desired version number of your package.

Additionally, you can specify any dependencies your package requires in the install_requires list. For example, if your package requires NumPy version 1.11.1 or higher, you can add 'numpy>=1.11.1' to the list.

It is also recommended to create a README.md file where you can describe your package. This file should be written in Markdown format and can provide information about the purpose of your package, how to install it, and any other relevant details.

Build Your Package

To build your package, you will need to use the setuptools and wheel libraries. These libraries allow you to generate distribution archives that can be installed using pip. You have already installed these from the first step of this tutorial.

You can build your package by running the following command:

python setup.py sdist bdist_wheel

This command will generate two distribution archives: a source distribution (sdist) and a wheel distribution (bdist_wheel). These archives contain all the necessary files for installing your package.

Local Testing

Before publishing your Python package, it's crucial to test it locally to ensure it functions correctly. Follow these steps to install and test your package using pip:

1. Open your terminal or command prompt.
2. Navigate to the directory where your package is located.
3. Run the following command to install your package locally.

pip install dist/xxx.whl

Replace the package name with the actual name and version of your package. Once the installation is complete, you can now test your package by importing it in a Python script or interactive session and using its functionality.

# In a different file...
from hanbin_hello import hello

hello()

By testing your package locally, you can identify and fix any issues before publishing it to PyPI.

Publish to PyPI

To publish your Python package to PyPI, you can use the twine tool.

twine upload dist/*

You will be prompted for your PyPI credentials. Once uploaded, anyone can install your package using.

pip install hanbin_hello

Useful Links

• Python Packaging User Guide
• setuptools documentation
• wheel documentation
• twine documentation
• PyPI