python开源项目目录结构参考

转载 2015年11月19日 14:05:45

转载:http://www.cnblogs.com/holbrook/archive/2012/02/24/2366386.html


每个真正的程序员,可能都会梦想着能够发布开源项目,让自己的代码被别人所用。开源项目会发布到开发的版本管理系统(比如GitHub)上面,为了让大家能够方便使用你的代码,项目的目录结构应该遵循一定的规范。即使不是开源项目,项目目录结构符合一定的规范对你的项目管理也是有好处的。

下面列出python开源项目的通常目录结构及说明:
.tx/                                       如果你使用Transifex进行国际化的翻译工作,创建此目录
        config                           Transifex的配置文件
$PROJ_NAME/                    按照你实际的项目名称创建目录。如果有多个子项目,就创建多个目录
docs/                                    项目文档
wiki/                                      如果有wiki,可以创建此目录
scripts/                                 项目用到的各种脚本
tests/                                    测试代码
extras/                                  扩展,不属于项目必需的部分,但是与项目相关的sample、poc等,下面给出4个例子:
        dev_example/
        production_example/
        test1_poc/
        test2_poc/
.gitignore                             版本控制文件,现在git比较流行
AUTHORS                           作者清单
INSTALL                              安装说明
LICENSE                              版权声明
MANIFEST.in                       装箱清单文件
MAKEFILE                           编译脚本
README                              项目说明文件,其他需要的目录下也可以放一个README文件,说明该目录的内容
setup.py                               python模块的安装脚本
 
这个目录结构是针对python项目的,各种语言习惯的目录结构可能不同,但一些基本的要素还是共同的,可以举一反三。

如何创建Python工程目录

如何创建一个简单但是比较规范的python工程目录,本文是学习了Learn Python the Hard Way相关内容后做的一些总结。...
  • jinxueliu31
  • jinxueliu31
  • 2015年10月12日 10:03
  • 6989

Python项目文件管理

目标文件和编写文件在同一个路径 目标导入文件父路径和编写文件在同一个路径 目标文件和编写文件的父目录是同一路径在编程的过程中,编程的风格也及其重要。除了在编程过程中要注意空行,加空格,以及合理的写注释...
  • meanong
  • meanong
  • 2017年01月02日 16:15
  • 722

11.python开源——工程项目结构

工程项目结构需要先弄清三个概念:包、模块、类         模块对应的是一个.py 文件,那么module_name 就是这个文件去掉.py 之后的文件名,py 文件中可以直接定义一些变量、函数、...
  • notbaron
  • notbaron
  • 2017年04月12日 22:53
  • 23633

开篇python--明白python文件如何组织,理解建立源文件

在Python 中引用是非常简单的事情,这里需要清楚三个概念就可以了包、模块、类。类这个就不用说了。 模块对应的是一个.py 文件,那么module_name 就是这个文件去掉.py 之后的文件名,...
  • wishfly
  • wishfly
  • 2016年10月11日 13:20
  • 1821

Python 基础语法_Python脚本文件结构

目录目录 前言 软件环境 Python Script文件结构 最后前言Python基础语法这一章,主要记录了Python的文件结构、逻辑运算符、算术操作符、控制流语句、输入和输出语句、函数、对象、类等...
  • Jmilk
  • Jmilk
  • 2015年09月19日 12:08
  • 3985

python项目目录结构

如何设计结构清晰的目录结构结构化你的Python工程
  • afanyusong
  • afanyusong
  • 2016年12月19日 16:45
  • 221

Python树形打印目录结构

前言这两天整理数据文件的时候发现,一层层的点击文件夹查看很繁琐,于是想写一个工具来递归打印出文件目录的树形结构,……最后终于发现了os.listdir这个函数,可是使用它来写一个深度优先搜索,只要递归...
  • shihengzhen101
  • shihengzhen101
  • 2017年09月07日 20:59
  • 735

[Python]模块文件结构

Python文件结构文件结构(范例全文) #/usr/bin/env python "this is a test module" import sys import os ...
  • humanking7
  • humanking7
  • 2015年04月26日 11:25
  • 1122

python 菜鸟成长记——搭建项目框架

python 菜鸟成长记——搭建项目框架 所在平台:windows7 首先抛开python的基本语法,学习python的人就需要学习django 所以,在这节先和大家说说,在没有系统学习语法之前...
  • miaoliqun1314
  • miaoliqun1314
  • 2016年09月20日 23:47
  • 1556

[python3.6 flask web学习]Flask项目目录结构

一个良好的项目结构目录可以清晰的看出来各个模块的作用,方便扩展,易于修改。虽然Flask并没有强制要求开发者项目的目录层次结构应该是怎么样的,但是如果我们以包和模块的形式组织项目的话,后期的开发会非常...
  • xingyunLOST
  • xingyunLOST
  • 2017年08月14日 10:13
  • 2338
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:python开源项目目录结构参考
举报原因:
原因补充:

(最多只允许输入30个字)