1.Why
在基于python的基础上,为了使用某些已打包好的功能,我们常常通过pip来安装一些第三方模块,从而简单快捷的实现某些复杂的计算工作。但是如何将已有的源代码封装成一个python包并提供给大家安装使用?
接下来的内容将详细介绍,如何打包你的项目并且上传到PyPI项目:
2.How
1) 首先先建立一个文件夹用于放整个python包的相关文件,例如本例子中:EVAtool
2)然后以python包的名字命名,并在该目录下,包含以下目录以及文件:
目录
bin:通常是存放需要用到的其他软件,例如这里是存放的在序列比对过程中用到的比对软件bowtie2等。
resource:存放参数相关的文件以及一些文档和模板,例如这里的序列比对过程中使用到的参数文件,reference_config.json等。
utils:存放实现该python包功能的不同模块的文件,如fastq.py是用于实现将.sra文件转换为fastq文件的子模块。
文件:
__init__.py: 在每个 Python 包中,你都会发现一个 __init__.py 文件。这个文件将告诉 Python 将目录作为模块(或子模块)处理。它将保存所有在其直接目录中的 Python 文件中的所有方法的名称。
一个典型的 __init__.py 文件有如下格式(当然也可以什么都不写):
from file import method # 'method' 是一个函数,存在于一个名为 'file.py' 的文件中
在 Python 中构建包时,你需要在包的每个子目录中添加一个 __init__.py 文件。这些子目录是包的子模块。如主目录下,resource以及utils中都添加了__init___.py
├── bin
│ ├── bedtools
│ ├── bowtie2
├── __init__.py
├── main.py
├── resource
│ ├── __init__.py
│ ├── logging.conf
│ ├── reference_config.json
└── utils
├── bam.py
├── config.py
├── fastq.py
3)在完成相应模块的功能之后,我们需要设置setup.py文件:
setup.py文件是构建实际模块必不可少的,该文件包含关于你的软件包的信息,特别是软件包的名称、版本、平台依赖性和其他很多信息。如该例子中的:
from io import DEFAULT_BUFFER_SIZE
from setuptools import setup, find_packages
MAJOR = 0
MINOR = 1
MICRO = 21
ISRELEASED = True
VERSION = f"{MAJOR}.{MINOR}.{MICRO}"
DESCRIPTION = "Extracellular Vesicles small RNAs Abundance and quantification tool"
with open("README.md", "r") as fh:
long_description = fh.read()
setup(
name="evatool",
version=VERSION,
keywords="evatool, small ncRNA, abundance, quantification",
description=DESCRIPTION,
long_description_content_type="text/markdown",
long_description=long_description,
author="xxx",
author_email="xxx",
url="https://github.com/xieguiyan/EVAtool",
packages=find_packages(),
include_package_data=True,
package_data={"evatool.resource": ["*.json", "*.conf", "*.html"], "evatool.bin": ["*"]},
install_requires=["numpy>=1.15", "pandas", "seaborn>=0.9.0", "jinja2"],
extras_require={
"dev": ["pytest", "pytest-cov", "pytest-mock", "pytest-xdist", "tox"],
"interactive": ["matplotlib"],
},
license="MIT",
platforms="any",
package_dir={"evatool": "evatool"},
python_requires=">=3.5",
entry_points={"console_scripts": ["evatool = evatool.main:main"]},
)
4)构建软件包,创建源码和轮子,准备上传到PyPI:
# python3 -m build (环境构建) source venv/bin/activate rm -rf dist build (删除已有的源码分布) python setup.py sdist bdist_wheel (构建新的源码分布和轮子)
3. what
PyPi 是官方的 Python 仓库,所有的 Python 包都存放在这里。你可以把它看作是 Python 软件包的 GitHub。
在PyPI网站上(PyPI · The Python Package Index)注册一个自己的账号,随后通过运行
pip install twine
安装twine,如果已经安装,则可忽略这一步。
最后一步,上传到PyPI:
python3 -m twine upload --repository testpypi dist/* (上传到PyPI)
按照相应的提示输入PyPI的用户名和密码即可,如果重复上传,记得更改包的名字或者版本号。



