发布python包到官方pypi上面¶

[TOC]

举个例子现在要发布 useful_decroation 这个包

imag1¶

发布一般需要 setup.py , LICENSE.txt package ,README.rst 等

1 首先要写一个 setup.py¶

主要通过这个脚本来实现发布

# -*- coding: utf-8 -*-
"""
@User     : Frank
@File     : setup.py
@DateTime : 2019-09-16 11:24
@Email    : frank.chang@lexisnexis.com
"""
from setuptools import setup,find_packages
import io
import re

with io.open('README.rst', 'r', encoding='utf8') as f:
    long_description = f.read()

with io.open("src/useful_decoration/__init__.py", "rt", encoding="utf8") as f:
    version = re.search(r'__version__ = "(.*?)"', f.read()).group(1)


setup(
    name="useful_decoration",
    license='Apache License 2.0',
    version=version,
    packages=find_packages("src"),
    zip_safe=False,
    include_package_data=True,
    package_dir={"": "src"},
    long_description=long_description,
    url='https://github.com/changyubiao/useful_decoration',
    author='frank',
    author_email='frank.chang@lexisnexis.com',
    description='powerful and useful decorations',

    project_urls={
        "Documentation": "https://useful-decoration.readthedocs.io/en/latest/",
        "Code": "https://github.com/changyubiao/useful_decoration",
    },

    python_requires='>=3.6',
    install_requires=[
        "loguru>=0.3.2",
    ],

)

有几个参数说一下: package 决定你要发哪个包 ,

name 就是报名

url 项目地址

version 可以在包里定义一个 __version__ 来制定 version

find_packages 这个是官方提供自动寻找包的一个方法, 他会寻找 package 下面的子包,如果项目比较大 ,用这个比较方便.

setup 参数官方文档

2 配置pypirc 文件¶

在用户家目录 .pypirc

用户名 ,密码从 pypi 官网注册一个 , 写到下面的配置文件里面 .

register 注册用户名, 密码 https://pypi.org/account/register/

/c/Users/xxxxx/.pypirc

[distutils]
index-servers=pypi

[pypi]
repository = https://upload.pypi.org/legacy/
username: changyubiao
password: xxxxxxxxx



[pypitest]
repository: https://test.pypi.org/legacy/
username:changyubiao
password:xxxxxxxxx

3 尝试本地打包发布¶

如果不确定发布正不正确, 可以先发到 pypitest 上面进行测试 , 没问题在像官方pypi 里面发布包

# 用它来发布先安装 这个
pip install twine
# 打包用到的包 安装 相应依赖
pip install setuptools wheel

# 检查打包文件
python setup.py  check

# 打包
python setup.py sdist bdist_wheel


# 发布包
twine upload dist/*