上传python的包至pypi服务器及crate.io

前言

我们经常可以看到github上的python开源项目有pipy的选项，及下载量的统计，是不是很惊讶于他们的professional?

见https://github.com/divio/django-cms

我们要如何打造自已的downloads统计?这个统计信息其实来自于crate.io,一个pypi的镜像站点，只要你上传了包在pypi,crate.io就会自动保存相关的包并统计相关信息.

另外,这个包传到pip上, 这样就可以直接用 pip install yourproject,或者只在requirments.txt中写个your-project就可以哦了;)

是不是也很想要在自已的开源项目加这个？那跟我来吧。

注册账号

1.https://pypi.python.org/pypi?%3Aaction=register_form

   记住你的密码（也可以用gmail登录)

项目修改

首先创建项目文件和setup文件。
目录文件结构如下：

project/
    simpletest/
        __init__.py
        test.py
    setup.py

假设项目文件只有一个simpletest包，里面有一个test.py文件。
创建的setup.py文件格式大致如下，其中，install_requires字段可以列出依赖的包信息，

用户使用pip或easy_install安装时会自动下载依赖的包。详细的格式参考文档。

from setuptools import setup, find_packages

setup(
    name = 'simpletest',
    version = '0.0.1',
    keywords = ('simple', 'test'),
    description = 'just a simple test',
    license = 'MIT License',
    install_requires = ['simplejson>=1.1'],

    author = 'test',
    author_email = 'not@all.com',
    
    packages = find_packages(),
    platforms = 'any',
)

代码打包,打包只需要执行python setup.py xxx命令即可，其中xxx是打包格式的选项，如下

# 以下所有生成文件将在当前路径下 dist 目录中
python setup.py bdist_egg # 生成easy_install支持的格式 
python setup.py sdist     # 生成pip支持的格式，下文以此为例

发布到pypi首先需要注册一个账号，然后进行如下两步：

注册package。输入python setup.py register。

上传文件。输入python setup.py sdist upload。

安装测试

上传成功后，就可以使用pip来下载安装了

另外，pypi还有一个测试服务器，可以在这个测试服务器上做测试，
测试的时候需要给命令指定额外的"-r"或"-i"选项，
如python setup.py register -r "https://testpypi.python.org/pypi", python setup.py sdist upload -r "https://testpypi.python.org/pypi", pip install -i "https://testpypi.python.org/pypi" simpletest

发布到测试服务器的时候，建议在linux或cygwin中发布，如果是在windows中，参考文档，需要生成.pypirc文件
在github你的项目中的README.rst中添加显示图片如cloudsafe改成你的项目名称

.. image:: https://pypip.in/v/cloudsafe/badge.png
    :target: https://crate.io/packages/cloudsafe/
.. image:: https://pypip.in/d/cloudsafe/badge.png
    :target: https://crate.io/packages/cloudsafe/

ps.你刚上传的项目不一定能在crate.io中搜到。但是你可以直接通过网址访问

https://crate.io/packages/cloudsafe/

最终效果如图

reference

http://yejinxin.github.io/distribute-python-packages-to-pypi-server/

http://liluo.org/blog/2012/08/how-to-create-python-egg/
http://blog.jkey.lu/2013/04/11/create-python-egg/
http://docs.python.org/2/distutils/index.html