Python 开源项目结构总结

推荐学习书目

› Learn Python the Hard Way

Python Sites

› PyPI - Python Package Index

› http://diveintopython.org/toc/index.html

› Pocoo

值得关注的项目

› PyPy

› Celery

› Jinja2

› Read the Docs

› gevent

› pyenv

› virtualenv

› Stackless Python

› Beautiful Soup

› 结巴中文分词

› Green Unicorn

› Sentry

› Shovel

› Pyflakes

› pytest

Python 编程

› pep8 Checker

Styles

› PEP 8

› Google Python Style Guide

› Code Style from The Hitchhiker's Guide

This topic created in 3351 days ago, the information mentioned may be changed or developed.

我参考了一些流行的 python 开源项目，总结一下 python 开源项目结构。

基本结构

结构说明

docs: 项目文档
tests: 测试代码
project: 项目内容
.gitignore: git 忽略文件
.travis.yml: 配置 travis ci
AUTHROS.md: 作者及贡献者列表
HISTORY.md:版本更新历史说明（也可以用 CHANGELOG.md ）
LISENCE: 开源协议
README.md: 项目说明
Makefile: 编译配置（很多时候用不上）
requirements.txt(运行依赖)
requirements.dev.txt(开发依赖)
requirements.test.txt(测试依赖)
setup.py: 安装配置，多用于发布到 pypi
tox.ini: 自动化测试工具 tox 配置

模板地址

https://github.com/gaojiuli/project

Python

开源

txt

travis

9 replies • 2017-04-05 22:16:32 +08:00

zhsj

Apr 4, 2017

官方指导 https://github.com/pypa/sampleproject

billlee

Apr 5, 2017

python 应该是用 README.rst

prasanta

Apr 5, 2017 via Android

@billlee rst 我没找到支持 checkbox 的语法

prasanta

Apr 5, 2017 via Android

@zsj950618 还是有点区别的

xiongbiao

Apr 5, 2017

感觉改动好像叫 changelog 的多一点

prasanta

Apr 5, 2017

@xiongbiao 我是看 kennethreits 的项目喜欢用 HISTORY, 而且这样感觉要舒服也一些．你觉得呢

fate0

Apr 5, 2017

可以看看这个模版 https://github.com/audreyr/cookiecutter-pypackage

prasanta

Apr 5, 2017 via Android

@fate0 这个也不错，在我参考的项目里面

glasslion

Apr 5, 2017

参照下面两个模板就够了:
https://github.com/pypa/sampleproject
https://github.com/audreyr/cookiecutter-pypackage

README.rst 的好处是能显示在 pypi.org 里，当然项目里用 .md, 打包时转成 .rst 的也不少, 但至少最终的包里应该是 .rst