Ausführliche Erläuterung zum Packen und Veröffentlichen von Python-Modulen

Vorwort

Gestern habe ich meine VASP-Dateiverarbeitungsbibliothek gepackt und auf PyPI hochgeladen. Jetzt können Sie VASPy direkt über pip und easy_install installieren (gleichzeitig sind Kinder, die VASP für Computerchemie verwenden, willkommen um Sterne hinzuzufügen) und mitmachen),

VASPys GotHub-Adresse: https://github.com/PytLab/VASPy
VASPys PyPI-Adresse: https://pypi.python.org/pypi/vaspy /

Da mein Gedächtnis wirklich schlecht ist und ich Angst habe, es nach langer Zeit zu vergessen, werde ich mein eigenes VASPy-Programm als Beispiel verwenden, um das Packen und Hochladen von Python zusammenzufassen.

VASPy-Paketdateistruktur

Schreiben und fügen Sie zunächst die gesamte Dateistruktur des VASPy-Pakets ein. Der folgende Inhalt wird anhand dieses Beispiels erläutert:

VASPy/
├── LICENSE
├── MANIFEST
├── MANIFEST.in
├── README.rst
├── requirements.txt
├── scripts
│  ├── change_incar_parameters.py
│  ├── create_inputs.py
│  └── ...
├── setup.cfg
├── setup.py
├── tests
│  ├── incar_test.py
│  ├── __init__.py
│  ├── oszicar_test.py
│  ├── outcar_test.py
│  ├── testdata
│  │  ├── CONTCAR
│  │  ├── DOS_SUM
│  │  ├── ELFCAR
│  │  └── ...
│  └── ...
└── vaspy
  ├── __init__.py
  ├── iter.py
  ├── matstudio.py
  └── ...
  
4 directories, 54 files

Verpackung und Tools zum Installieren von Paketen von Drittanbietern

Hier müssen wir Tools wie setuptools und pip verwenden, um unsere eigenen Pakete zu packen, zu veröffentlichen und zu installieren. Wenn wir ein Rad erstellen müssen, müssen wir auch das Radmodul installieren . Wenn die Python-Version >=2.7.9 oder >=3.4, setuptools und pip bereits installiert sind, müssen Sie möglicherweise auf die neueste Version aktualisieren

pip install -U pip setuptools

Sie können Paketverwaltungstools wie

yum install pip
sudo apt-get install pip

verwenden, um über das Skript get-pip.py zu installieren. Wenn festgestellt wird, dass Wheel und Setuptools nicht installiert sind, werden sie ebenfalls automatisch installiert

python get-pip. py

Ich werde nicht auf Details zur Installation und Einführung des Tools eingehen. Sie können sich auf die Anforderungen für die Installation von Paketen beziehen.

Die Rolle verschiedener Dateien im Paket

setup.py

Diese Datei ist die wichtigste Datei zum Packen des gesamten Projekts. Sie bietet zwei Hauptfunktionen:

setup(). Funktion Die Parameter dieser Funktion legen fest, wie Sie Ihr eigenes Projekt konfigurieren.
Befehlszeilentools, einschließlich Packen, Testen, Veröffentlichen usw. Sie können es mit dem folgenden Befehl anzeigen:

python setup.py --help-commands

setup.cfg

Diese Datei enthält beim Erstellen einige Standardparameter, z Erstellen von bdist_wheel Der Parameter --universal

[bdist_wheel]
universal=1

wird standardmäßig jedes Mal beim Packen verwendet. Der Effekt ist ähnlich:

python setup.py bdist_wheel --universal

README.rst

Ich habe dies ursprünglich in Markdown geschrieben und auf PyPI veröffentlicht. Ich habe festgestellt, dass PyPI das Markdown-Rendering nicht unterstützt, also habe ich reStrutruedText verwendet Grammatik wurde neu geschrieben. Schließlich kann die Syntax der Auszeichnungssprache grundsätzlich in Sekundenschnelle erlernt werden. Wenn das wirklich nicht möglich ist, suchen Sie sich einfach eine Vorlage und zeichnen Sie den Kürbis.
Die Syntaxregeln von reStructureText finden Sie im offiziellen Dokument: Quick reStructuredText

Tatsächlich besteht eine andere Möglichkeit darin, pandoc zu verwenden, um Markdown in das erste Format zu konvertieren Pyandoc-Modul zur automatischen Konvertierung beim Veröffentlichen.
Spezifische Methoden finden Sie unter: Markdown-READMEs in Python-Modulen verwenden

MANIFEST.in

Diese Datei teilt Setuptools beim Packen mit, dass zusätzliche Dateien gepackt werden müssen, z. B. die Einheiten In meinem VASPy werde ich diese Datei verwenden, um die Testdatendatei für den Test einzubinden. Natürlich können README und LICENSE auch zusammen gepackt werden.
Das Folgende ist der Inhalt meines eigenen MANIFEST.in:

include README.rst
include requirements.txt
include LICENSE
recursive-include scripts *
recursive-include tests *

Spezifische Grammatikregeln finden Sie unter: Die MANIFEST.in-Vorlage

vaspy/

Dieser Ordner ist das Paket, in dem sich der Vaspy-Quellcode befindet.

tests/

Dieser Ordner ist ebenfalls ein Unterpaket und enthält Unit-Test-Skripte. Um python setup.py test für Unit-Tests zu verwenden, wird __init__.pys speziell hinzugefügt Eine Tasche.

Parameter von setup()

Hier sind nur einige Parameter, die ich verwende. Informationen zur spezifischen Verwendung anderer Parameter finden Sie unter: https://docs.python.org/3/. distutils/setupscript .html

name

versions = "vaspy"

ist der Name des gesamten Projekts. Dieser Name und die Versionsnummer werden nach dem Packen verwendet .

Version

from vaspy import __version__
version = __version__

Beschreibung

ist eine kurze Beschreibung des Projekts, normalerweise nur ein Satz, und wird am Ende des Namens auf Pypi angezeigt.

long_description

ist eine lange Beschreibung, die einer prägnanten Beschreibung des Projekts entspricht. Wenn diese Zeichenfolge im ersten Format vorliegt, rendert PyPI sie automatisch zur Anzeige in HTML. Der Inhalt in README.rst kann hier direkt gelesen werden.

URL

Der Link zum Paket, normalerweise ein Link auf GitHub oder ein Link zu readthedocs.

Pakete

Eine Liste der Unterpakete, die enthalten sein müssen, stellt find_packages() zur Verfügung, um uns bei der Suche nach Paketen im Root-Pfad zu helfen.

setup_requires

Dieser Parameter definiert andere Abhängigkeiten (die grundlegendsten), die für die Installation und den reibungslosen Betrieb von VASPy erforderlich sind. Diese Abhängigkeiten werden installiert, wenn pip zur Installation verwendet wird.
Informationen zum Unterschied zwischen diesem Parameter und „requirements.txt“ finden Sie unter: install_requires vs. Anforderungsdateien

Klassifikator

Dieser Parameter stellt eine Reihe von Klassifizierungen bereit, die in verschiedene Kategorien eingeteilt werden auf PyPI Die Elemente werden im Verzeichnis kategorisiert.
Referenz für spezifische Kategorienamen und Regeln: https://pypi.python.org/pypi?%3Aaction=list_classifiers

test_suite

Dieser Parameter kann uns bei der Verwendung von

python setup.py test

Um Unit-Tests auszuführen, müssen Sie kein separates Skript mehr wie run_tests.py schreiben, um Unit-Tests auszuführen.

Offizielle Erklärung dieses Parameters:

A string naming a unittest.TestCase subclass (or a package or module containing one or more of them, or a method of such a subclass), or naming a function that can be called with no arguments and returns a unittest.TestSuite. If the named suite is a module, and the module has an additional_tests() function, it is called and the results are added to the tests to be run. If the named suite is a package, any submodules and subpackages are recursively added to the overall test suite.

也就是说这个参数可以接受多种类型的参数：

接收unittest.TestCase子类，我们可以讲所有单元测试写入一个测试用例中，然后import进来，再传你给test_suite
接收函数对象，此函数对象没有任何参数，且返回一个unittest.TestSuite.这样我们就可以单独写一个函数，将多个测试用例合并成一个suite然后返回，然后再将函数import进来传给test_suite。

模块和包名称，我就是使用这种方式，之前自己的测试都是分开的多个脚本，这样我添加一个__init__.py就可以将其变成一个包，将包名传给test_suite，setuptools就会神奇的将此包下的所有测试全部跑一边，这样我以后再加测试脚本的时候直接就添加新的脚本就好了，其他的都不需要改动了。

运行效果：

zjshao@SHAO-PC:/mnt/d/Dropbox/Code/CentOS_code/VASPy$ python setup.py test
running test
running egg_info
creating vaspy.egg-info
writing vaspy.egg-info/PKG-INFO
writing top-level names to vaspy.egg-info/top_level.txt
writing dependency_links to vaspy.egg-info/dependency_links.txt
writing manifest file 'vaspy.egg-info/SOURCES.txt'
reading manifest file 'vaspy.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'vaspy.egg-info/SOURCES.txt'
running build_ext
test_compare (tests.incar_test.InCarTest)
Make sure we can compare two InCar objects correctly. ... ok
test_eq (tests.incar_test.InCarTest)
Test __eq__() function. ... ok
...
此处省略若干输出
  
----------------------------------------------------------------------
Ran 22 tests in 3.574s
  
OK

发布自己的python包

1. 首先先去PyPI注册帐号

2. 配置~/.pypirc如下：

[distutils]
index-servers =
  pypi
  pypitest
  
[pypi]
username:ShaoZhengjiang
password:mypassword
  
[pypitest]
username:ShaoZhengjiang
password:mypassword

3. 然后注册并上传自己的包到测试服务器

pypi提供了一个测试服务器，我们可以在这个测试服务器上做测试。

python setup.py register -r pypitest

然后

python setup.py sdist upload -r pypitest

若没有问题我们应该不会得到任何错误。

4. 上传至PyPI

若上面的测试成功，我们就可以按照相同的步骤将包注册并上传。

python setup.py register -r pypi
python setup.py sdist upload -r pypi

Ok,之后我们就可以在PyPI(https://pypi.python.org/pypi/vaspy/)上看到我们自己的包了。

更多打包发布Python模块的方法详解相关文章请关注PHP中文网！