怎么在Python中構(gòu)建程序包

本篇文章給大家分享的是有關(guān)怎么在Python中構(gòu)建程序包，小編覺(jué)得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說(shuō)，跟著小編一起來(lái)看看吧。

python主要應(yīng)用領(lǐng)域有哪些

1、云計(jì)算，典型應(yīng)用OpenStack。2、WEB前端開(kāi)發(fā)，眾多大型網(wǎng)站均為Python開(kāi)發(fā)。3.人工智能應(yīng)用，基于大數(shù)據(jù)分析和深度學(xué)習(xí)而發(fā)展出來(lái)的人工智能本質(zhì)上已經(jīng)無(wú)法離開(kāi)python。4、系統(tǒng)運(yùn)維工程項(xiàng)目，自動(dòng)化運(yùn)維的標(biāo)配就是python+Django/flask。5、金融理財(cái)分析，量化交易，金融分析。6、大數(shù)據(jù)分析。

本文使用到的項(xiàng)目目錄為

? packaging-tutorial
.
└── bestpkg
  └── __init__.py

接下來(lái)的所有操作都是在 packing_tutorial 這個(gè)目錄下進(jìn)行的。首先把 bestpkg 這個(gè)目錄下的 __init__.py 添加以下內(nèi)容

info='packaging demo'

這個(gè)信息主要用于打包成功后安裝測(cè)試用的。

0x01 項(xiàng)目結(jié)構(gòu)

一個(gè)待發(fā)布的項(xiàng)目還需要有以下這些文件： setup.py 、 LICENSE 和 README.md

? packaging-tutorial
.
├── LICENSE
├── README.md
├── bestpkg
│  └── __init__.py
└── setup.py

0x02 setup.py

setup.py 文件是給 setuptools 工具的使用腳本，告訴 setuptools 如何構(gòu)建我們的項(xiàng)目。打開(kāi)編輯器，編輯 setup.py 文件，輸入以下內(nèi)容

import setuptools

# 讀取項(xiàng)目的readme介紹
with open("README.md", "r") as fh:
  long_description = fh.read()

setuptools.setup(
  name="bestpkg",# 項(xiàng)目名稱(chēng)，保證它的唯一性，不要跟已存在的包名沖突即可
  version="0.0.1",
  author="hylinux1024", # 項(xiàng)目作者
  author_email="hylinux1024@gmail.com",
  description="一個(gè)牛逼的程序", # 項(xiàng)目的一句話描述
  long_description=long_description,
  long_description_content_type="text/markdown",
  url="https://github.com/hylinux1024/niubiproject",# 項(xiàng)目地址
  packages=setuptools.find_packages(),
  classifiers=[
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
  ],
)

• name 
  

• 項(xiàng)目名稱(chēng)，保證它的唯一性，不要跟已存在的包名沖突即可，否則會(huì)發(fā)布失敗
  

• version 
  

• 版本號(hào)
  

• author 
  

• 作者

• author_email 

• 作者郵箱

• description 

• 一句話描述項(xiàng)目

• long_description 

• 項(xiàng)目詳細(xì)說(shuō)明，一般直接讀取README.md的內(nèi)容

• url 

• 項(xiàng)目的鏈接地址

• packages 

• 列出當(dāng)前項(xiàng)目的包，一般直接使用 find_packages() 即可

• classifiers 

• 這里指定 Python 的兼容版本是 Python3 ，也指定了項(xiàng)目使用的開(kāi)源協(xié)議。

• 
  

0x03 README.md

給項(xiàng)目添加詳細(xì)的 README

# Example Package

This is a simple example package. You can use
[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
to write your content.

0x04 LICENSE

要發(fā)布包到 pypi 上，選擇一個(gè)合適的開(kāi)源協(xié)議是非常重要的。如果不知道怎么選可以到choosealicense.com/這里看看。

0x05 項(xiàng)目打包

項(xiàng)目需要打包后才能發(fā)布，要打包項(xiàng)目需先安裝最新版本的 setuptools 和 wheel

? python3 -m pip install --user --upgrade setuptools wheel

然后使用以下命令進(jìn)行打包

? python3 setup.py sdist bdist_wheel

當(dāng)看到以下信息，說(shuō)明已經(jīng)打包成功

...
...
...
adding license file "LICENSE" (matched pattern "LICEN[CS]E*")
creating build/bdist.macosx-10.14-x86_64/wheel/bestpkg-0.0.1.dist-info/WHEEL
creating 'dist/bestpkg-0.0.1-py3-none-any.whl' and adding 'build/bdist.macosx-10.14-x86_64/wheel' to it
adding 'bestpkg/__init__.py'
adding 'bestpkg-0.0.1.dist-info/LICENSE'
adding 'bestpkg-0.0.1.dist-info/METADATA'
adding 'bestpkg-0.0.1.dist-info/WHEEL'
adding 'bestpkg-0.0.1.dist-info/top_level.txt'
adding 'bestpkg-0.0.1.dist-info/RECORD'
removing build/bdist.macosx-10.14-x86_64/wheel

在項(xiàng)目目錄下會(huì)生成一個(gè) dist 和 build 文件夾

? packaging-tutorial tree
.
├── LICENSE
├── README.md
├── bestpkg
│  └── __init__.py
├── bestpkg.egg-info
│  ├── PKG-INFO
│  ├── SOURCES.txt
│  ├── dependency_links.txt
│  └── top_level.txt
├── build
│  ├── bdist.macosx-10.14-x86_64
│  ├── bdist.macosx-10.9-x86_64
│  └── lib
│    └── bestpkg
│      └── __init__.py
├── dist
│  ├── bestpkg-0.0.1-py3-none-any.whl
│  └── bestpkg-0.0.1.tar.gz
└── setup.py

8 directories, 11 files

在 dist 文件中有兩個(gè)文件

dist
  ├── bestpkg-0.0.1-py3-none-any.whl
  └── bestpkg-0.0.1.tar.gz

tar.gz 文件是源碼文件壓縮包，而 .whl 就是打包后的文件。最新的 pip 命令會(huì)安裝這個(gè) .whl 文件。

0x06 上傳

現(xiàn)在就可以上傳到 Python 索引庫(kù)了。我們使用 Test PyPI ，這個(gè)是測(cè)試用的 Pypi ，本例子也是使用 Test Pypi 。

首先要到 test.pypi.org/account/reg… 注冊(cè)賬號(hào)。本例中我注冊(cè)的賬號(hào)為： hylinux1024 。

然后使用 twine 工具來(lái)上傳我們的包。使用以下命令進(jìn)行安裝：

? python3 -m pip install --user --upgrade twine

使用以下命令上傳 dist 目錄下的文件

? python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

這個(gè)命令會(huì)提示輸入剛在 test.pypi.org 上注冊(cè)賬號(hào)密碼，并出現(xiàn)類(lèi)似以下信息后說(shuō)明已經(jīng)上傳成功。

Enter your username: hylinux1024
Enter your password:
Uploading distributions to https://test.pypi.org/legacy/
Uploading bestpkg-0.0.1-py3-none-any.whl
100%|██████████████████████████████████████| 4.57k/4.57k [00:00<00:00, 8.01kB/s]
Uploading bestpkg-0.0.1.tar.gz
100%|██████████████████████████████████████| 4.18k/4.18k [00:01<00:00, 3.23kB/s]

然后打開(kāi) test.pypi.org/project/bes… 這個(gè)地址就可以看到我們發(fā)布的包。

0x07 安裝

發(fā)布成功之后就可以使用 pip 來(lái)安裝來(lái)。我們?cè)谔摂M環(huán)境中安裝，關(guān)于虛擬環(huán)境可以看我前一篇文章。

這里就使用 pipenv ，這里我直接進(jìn)入到我昨天創(chuàng)建的那個(gè)項(xiàng)目中，也為了更好演示安裝結(jié)果。

? pip install --index-url https://test.pypi.org/simple/ --no-deps bestpkg

在這里我使用 --index-url 參數(shù)是為了指定從 test.pypi.org 中安裝，而不是正式包索引庫(kù)中查找要安裝的包。還有使用了 --no-deps 參數(shù)是因?yàn)楸纠袥](méi)有使用到其它的依賴(lài)庫(kù)。

在終端會(huì)看到以下類(lèi)似信息，說(shuō)明安裝成功

Looking in indexes: https://test.pypi.org/simple/
Collecting bestpkg
 Downloading https://test-files.pythonhosted.org/packages/5a/fc/c109b3872b6c06e7368c30b6e52501113846f90ca716a434766151093173/bestpkg-0.0.1-py3-none-any.whl
Installing collected packages: bestpkg
Successfully installed bestpkg-0.0.1

進(jìn)入交互界面

(pipenvdemo) ? pipenvdemo python
>>> import bestpkg
>>> bestpkg.info
'packaging demo'

info 變量就是在 __init__.py 文件中定義的變量。自此我們的包發(fā)布、安裝使用流程就走完了。

要在正式的 Python 索引庫(kù)中發(fā)布，只需要到pypi.org/注冊(cè)賬號(hào)，并上傳就可以了。

以上就是怎么在Python中構(gòu)建程序包，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。