Explication détaillée de la façon de conditionner et de publier des modules Python

Avant-propos

Hier, j'ai empaqueté ma bibliothèque de traitement de fichiers VASP et je l'ai téléchargée sur PyPI. Vous pouvez désormais installer VASPy directement via pip et easy_install (en même temps, les enfants qui utilisent VASP pour faire de la chimie computationnelle sont les bienvenus. pour ajouter des étoiles) et s'impliquer),

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

Comme ma mémoire est vraiment mauvaise et que j'ai peur de l'oublier après une longue période, j'utiliserai mon propre programme VASPy comme exemple pour résumer l'empaquetage et le téléchargement de Python.

Structure des fichiers du package VASPy

Écrivez et collez d'abord la structure complète des fichiers du package VASPy. Le contenu suivant sera expliqué à l'aide de cet exemple :

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

Emballage et. Outils pour installer des packages tiers

Ici, nous devons utiliser des outils tels que setuptools et pip pour empaqueter, publier et installer nos propres packages. Si nous devons créer une roue, nous devons également installer le module wheel. . Si la version python >=2.7.9 ou >=3.4, setuptools et pip sont déjà installés, vous devrez peut-être mettre à jour vers la dernière version

pip install -U pip setuptools

Vous pouvez utiliser des outils de gestion de packages, tels que

yum install pip
sudo apt-get install pip

pour installer via le script get-pip.py S'il est détecté que wheel et setuptools ne sont pas installés, il sera également automatiquement installé <🎜. >

python get-pip.py

Je n'entrerai pas dans les détails sur l'installation et l'introduction spécifiques de l'outil. Vous pouvez vous référer aux exigences d'installation des packages

Le. rôle des différents fichiers dans le package

setup.py

Ce fichier est le fichier le plus important pour empaqueter l'ensemble du projet. Il fournit deux fonctions principales :

setup(). fonction. Les paramètres de cette fonction précisent comment configurer votre propre projet.

Outils de ligne de commande, y compris l'empaquetage, les tests, la publication, etc. Vous pouvez le visualiser via la commande suivante :

python setup.py --help-commands

setup.cfg

Ce fichier contient certains paramètres par défaut lors de la construction, tels que construction de bdist_wheel Le paramètre --universal

[bdist_wheel]
universal=1

sera utilisé par défaut à chaque fois lors de l'empaquetage. L'effet est similaire :

python setup.py bdist_wheel --universal

<🎜. >
README.rst

J'ai initialement écrit ceci en markdown. Après l'avoir emballé et publié sur PyPI, j'ai découvert que PyPI ne prenait pas en charge le rendu markdown. La page était vraiment chaotique, j'ai donc utilisé reStrutruedText. la grammaire a été réécrite. Après tout, la syntaxe du langage de balisage peut être apprise en quelques secondes. Si ce n'est vraiment pas possible, il suffit de trouver un modèle et de dessiner la gourde. Pour les règles de syntaxe de

reStructureText, veuillez vous référer au document officiel : Quick reStructuredText

En fait, une autre façon consiste à utiliser pandoc pour convertir le markdown au premier format. module pyandoc pour convertir automatiquement lors de la publication.

Pour des méthodes spécifiques, veuillez vous référer à : Utiliser les README de Markdown dans les modules Python

MANIFEST.in

Ce fichier indique aux outils de configuration lors de l'empaquetage que des fichiers supplémentaires doivent être empaquetés, tels que les unités. dans mon VASPy, j'utiliserai ce fichier pour inclure le fichier de données de test pour le test. Bien entendu, README et LICENSE peuvent également être regroupés via celui-ci.

Ce qui suit est le contenu de mon propre MANIFEST.in :

Pour les règles de grammaire spécifiques, veuillez vous référer à : Le modèle MANIFEST.in

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

vaspy/

Ce dossier est le package où se trouve le code source de Vaspy.

tests/

Ce dossier est également un sous-package et contient des scripts de tests unitaires Afin d'utiliser python setup.py test pour les tests unitaires, __init__.pys est spécialement ajouté pour le réaliser. Un sac.

Paramètres de setup()

Voici seulement quelques paramètres que j'utilise. Pour l'utilisation spécifique d'autres paramètres, veuillez vous référer à : https://docs.python.org/3/. distutils/setupscript .html

name

versions = "vaspy"

est le nom de l'ensemble du projet. Ce nom et ce numéro de version seront utilisés après l'empaquetage. .

version

description

from vaspy import __version__
version = __version__

est une brève description du projet, généralement une seule phrase, et sera affichée au bas du nom sur pypi.

long_description

est une longue description, qui équivaut à une description concise du projet si cette chaîne est au premier format, PyPI la restituera automatiquement en HTML pour l'affichage. Le contenu du fichier README.rst peut être lu directement ici.

url

Le lien vers le package, généralement un lien sur GitHub ou un lien vers lire la documentation.

packages

Une liste de sous-packages qui doivent être inclus. setuptools fournit find_packages() pour nous aider à trouver les packages dans le chemin racine. Cette fonction distutil n'a pas.

setup_requires

Ce paramètre définit d'autres dépendances (les plus basiques) nécessaires à l'installation et au bon fonctionnement de VASPy. Ces dépendances seront installées lors de l'utilisation de pip pour installer.

Pour la différence entre ce paramètre et Requirements.txt, veuillez vous référer à : install_requires vs Requirements files

classifier

Ce paramètre fournit une série de classifications, qui seront classées dans différentes catégories sur PyPI Les éléments sont classés dans le répertoire.

Référence pour les noms et règles de catégories spécifiques : https://pypi.python.org/pypi?:action=list_classifiers

test_suite

Ce paramètre peut nous aider à utiliser

python setup.py test

pour exécuter des tests unitaires, vous n'avez plus besoin d'écrire un script séparé tel que run_tests.py pour exécuter des tests unitaires.

Explication officielle de ce paramètre :

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中文网！