V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
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
prasanta
V2EX  ›  Python

Python 开源项目结构总结

  •  
  •   prasanta · 2017-04-04 19:17:58 +08:00 · 3804 次点击
    这是一个创建于 2791 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    基本结构

    clipboard.png

    结构说明

    • 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

    9 条回复    2017-04-05 22:16:32 +08:00
    zsj950618
        1
    zsj950618  
       2017-04-04 22:42:00 +08:00   ❤️ 1
    billlee
        2
    billlee  
       2017-04-05 01:05:13 +08:00
    python 应该是用 README.rst
    prasanta
        3
    prasanta  
    OP
       2017-04-05 08:33:26 +08:00 via Android
    @billlee rst 我没找到支持 checkbox 的语法
    prasanta
        4
    prasanta  
    OP
       2017-04-05 08:33:51 +08:00 via Android
    @zsj950618 还是有点区别的
    xiongbiao
        5
    xiongbiao  
       2017-04-05 13:06:39 +08:00
    感觉改动好像叫 changelog 的多一点
    prasanta
        6
    prasanta  
    OP
       2017-04-05 14:33:19 +08:00
    @xiongbiao 我是看 kennethreits 的项目喜欢用 HISTORY, 而且这样感觉要舒服也一些.你觉得呢
    fate0
        7
    fate0  
       2017-04-05 19:46:02 +08:00
    prasanta
        8
    prasanta  
    OP
       2017-04-05 19:50:50 +08:00 via Android
    @fate0 这个也不错,在我参考的项目里面
    glasslion
        9
    glasslion  
       2017-04-05 22:16:32 +08:00
    参照下面两个模板就够了:
    https://github.com/pypa/sampleproject
    https://github.com/audreyr/cookiecutter-pypackage

    README.rst 的好处是能显示在 pypi.org 里, 当然项目里用 .md, 打包时转成 .rst 的也不少, 但至少最终的包里应该是 .rst
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   937 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 21:18 · PVG 05:18 · LAX 13:18 · JFK 16:18
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.