Python 是一種廣泛應用于 Web 開發(fā)、科學計算、數據分析等領域的編程語言。它的簡潔、直觀和易于學習被廣泛認可。許多人都希望能夠貢獻自己的代碼庫來豐富社區(qū)資源。本文將介紹 Python 中如何創(chuàng)包。
首先,打開命令行終端,在項目目錄下創(chuàng)建一個文件夾。這個文件夾將成為項目的根目錄。將其命名為你的包名。
mkdir your_package_name
cd your_package_name
在該目錄下執(zhí)行以下命令,創(chuàng)建以下文件和文件夾。
touch README.md
touch LICENSE
touch setup.py
mkdir your_package_name
touch your_package_name/__init__.py
一些解釋:
- README.md - 這是你的項目文檔。它應該描述你的項目是做什么的,如何使用,還可以包含如何安裝你的包等信息。
- LICENSE - 這是你的項目許可證文件。如果你沒有為你的項目選擇許可證,請參考開源許可證網站(如https://choosealicense.com/)。
- setup.py - 這是你的包的“清單”。它包含了有關你的包的基本信息,如名稱、版本、作者等。
- your_package_name - 這是你的包的源代碼目錄。它應該包含一個名為__init__.py的空文件,該文件告訴 Python 它是一個模塊。模塊是 Python 中包含代碼的基本單位。
接下來,編輯 setup.py 文件。以下是一個基本的例子。
from setuptools import setup, find_packages
setup(
name='your-package-name',
version='0.1',
packages=find_packages(),
license='MIT',
author='Your Name',
author_email='your-email@email.com',
description='Your package description',
keywords=['keyword1', 'keyword2']
)
這個 setup.py 文件描述了你創(chuàng)造的包的一些基本信息。其中 name、version、description、author、author_email、license 是必須的,其他信息可以自定義。請注意,find_packages()查找你的 Python 包的所有目錄,包括項目根目錄中未在 setup.py 中列出的所有子目錄。
最后,將你的包推送到 Python 包索引(PyPI)。
pip install twine
python setup.py sdist
twine upload dist/*
以上命令將創(chuàng)建你的包,然后使用 Twine 將其上傳到 PyPI。在上傳之前,請確保你具有 PyPI 的登錄憑據。
創(chuàng)造你的第一個 Python 包吧!