Python 的 pypi.python.org 站点终于要退休了,而新的接任者 pypi.org 无论从美观、风格上都让人大大的喜欢,终于在审美一这项上及格了。
而且新的 pypi.org 能够正确的渲染 Markdown 格式的描述,实在是让人欣慰,终于可以和 Github 同步了,不用在麻烦的转换一次了。
下面就来聊聊,如何正确的把库发布到 pypi.org 上:
嗯,这是正确的废话!
setup.py 的内容比较重要,但其它的细节不谈,主要聊聊 long_description 部分,这部分是对库能力的详细描述。
如果说 keywords 和 description 能提高别人搜索到项目的概率的话,那 long_description 就在很大程度上决定别人对你对项目有没有进一步的想法了。
在针对 long_description 的网上介绍中,对具体使用方法明确写出的是少之又少,所以我今天就特别举例说明一下。
#!/usr/bin/env python
# coding: utf-8
from setuptools import setup
setup(
name='sequence2hash',
version='1.1.2',
keywords='tuple dict list sequence hash key/value',
packages=['sequence2hash'],
url='https://github.com/Cuile/sequence2hash',
description='This tool converts a valid value in a sequence to a hash and contains a path to a valid value in the key field',
long_description_content_type='text/markdown',
long_description=open('README.md', encoding='utf8').read(),
author='cuile',
author_email='[email protected]'
)
long_description=open('README.md', encoding='utf8').read()
这句代码是较少明确说明的,可以不引用 io 库,而直接使用 open 函数读取文件内容,由于 pypi.org 支持 Markdown ,所以可以和 Github 使用同一份 README.md 文件。