《笨办法学Python》笔记33-----一个项目骨架

骨架目录

为什么要建立这么个骨架?

建立一个项目的骨架目录就如同代码风格,统一规范的项目骨架目录应当是能提高项目的可读性的,进而为后来人提供快速方便的项目维护参考,降低项目维护的成本。

基本的框架包括项目布局,自动化测试,模块,安装脚本。

ubuntu下新建目录和文件的命令分别是:

建立目录 mkdir

建立文件 touch

按以下结构建立项目骨架

.
├── bin
├── docs
├── NAME
│   └── __init__.py
├── setup.py
└── tests
    ├── __init__.py
    └── NAME_tests.py

4 directories, 4 files

骨架下的这些文件和文件夹各有什么作用?

bin:存放可执行文件

docs:存放项目文档

NAME:是与项目名称一致的文件夹,可用大小写与项目根目录名区分开来。主要用来存放项目源代码文件,包括模块、包等。

setup.py:是项目安装、部署、打包的脚本

tests:主要存放项目测试代码

可参考
设计清晰的python项目目录结构
开源一个python项目的正确方式

安装软件包

pip

sudo apt intall python-pip

pip是一个以Python计算机程序语言写成的软件包管理系统,他可以安装和管理软件包

pip的其中一个主要特点就是其方便使用的命令列界面,这让使用者可以透过以下的一句文字命令来轻易地安装Python软件包:

pip install some-package-name

此外,使用者也可以轻易地透过以下的命令来移除软件包:

pip uninstall some-package-name

pip也拥有一个透过“需求”档案来管理软件包和其相应版本数目的完整列表之功能,这容许一个完整软件包组合可以在另一个环境(如另一部电脑)或虚拟化环境中进行有效率的重新创造。这个功能可以透过一个已正确进行格式化的文字档案和以下的命令来完成:

pip install -r requirements.txt

distribute

sudo apt intall python-distribute

这又是一个包管理工具。官方网站介绍说

`Distribute` is a now deprecated fork of the `Setuptools` project.

Distribute was intended to replace Setuptools as the standard method
for working with Python module distributions. The code has since been merged
back into the parent project as is being maintained by the community at large.

`Distribute` is now being maintained as a branch in the `Setuptools repository

作为一个初学者,可能已经被众多包管理工具搞糊涂了,以下是一系列文章,可以参考

python包管理工具解惑
Python 的包管理工具 distribute, setuptools, easy_install 与 pip

nose

sudo apt intall python-nose

nose是用于python程序单元测试的第三方包

virtualenv

sudo apt intall python-virtualenv

virtualenv 用来创建隔离的Python环境

  • 建立一个虚拟环境:virtualenv 目录名

damao@damao:~$ virtualenv ~/Desktop/virtualpython

Running virtualenv with interpreter /usr/bin/python2
New python executable in /home/damao/Desktop/virtualpython/bin/python2
Also creating executable in /home/damao/Desktop/virtualpython/bin/python
Installing setuptools, pkg_resources, pip, wheel...done.

  • 激活一个虚拟环境:进入上一步创建的目录执行 source bin/activate

damao@damao:~/Desktop/virtualpython$ source bin/activate

(virtualpython) damao@damao:~/Desktop/virtualpython$

激活成功的话,提示符前面会显示之前创建的虚拟环境的名称

  • 虚拟环境下安装包:使用pip或setup.py都行

## 在虚拟环境中安装bottle框架:

(virtualpython) damao@damao:~/Desktop/virtualpython$ pip install bottle

Collecting bottle
  Downloading bottle-0.12.9.tar.gz (69kB)
    100% |████████████████████████████████| 71kB 100kB/s
Building wheels for collected packages: bottle
  Running setup.py bdist_wheel for bottle ... done
  Stored in directory: /home/damao/.cache/pip/wheels/6e/87/89/f7ddd6721f4a208d44f2dac02f281b2403a314dd735d2b0e61
Successfully built bottle
Installing collected packages: bottle
Successfully installed bottle-0.12.9


## 进入虚拟环境的bin目录可以查看刚安装的bottle框架


(virtualpython) damao@damao:~/Desktop/virtualpython/bin$ ls

activate       activate_this.py  easy_install      pip2    python2        wheel
activate.csh   bottle.py         easy_install-2.7  pip2.7  python2.7
activate.fish  bottle.pyc        pip               python  python-config


  • 退出虚拟环境:deactivate

virtualenv文档

setup.py

try:
    from setuptools import setup
except ImportError:
    from distutils.core import setup


config = {
    'description':'My project',
    'author':'My name',
    'url':'URL to get it at.',
    'download_url':'Where to download it.',
    'author_email':'My email',
    'version':'0.1',
    'install_requires':['nose'],
    'packages':['NAME'],
    'scripts':[],
    'name':'projectname'
}

setup(**config)

setup.py是一个项目中必不可少的文件,使用

python setup.py sdist

可以分享你的包给社区,别人可以通过使用

python setup.py install

来安装你的包。

setup()是setuptools或者distutils.core中的一个函数,setup函数接收很多个参数,上例中的参数解释如下:

'description':关于该模块的单行描述
'author':模块作者
'url':模块主页
'download_url':模块下载链接
'author_email':作者电邮
'version':模块版本号
'install_requires':此模块依赖的模块,
'packages':告诉distutils需要处理的包
'scripts':指定源码文件,可从命令行执行
'name':模块名

distutils.core中setup函数的定义

setuptools文档

setuptools源码

writing the setup script

关于python中的setup.py

setup.py文件详解

以树形结构图显示目录

在Ubuntu系统中打开终端,输入命令tree

若之前没有安装过,会出现以下信息

owen@ubuntu:~/Documents/test/tests$ tree
The program 'tree' is currently not installed. You can install it by typing:
sudo apt-get install tree

根据提示,输入命令sudo apt-get install tree,开始tree程序安装

待安装完成后,在终端的任意目录下输入tree,即可以树形结构的方式显示该目录下的所有文件夹及文件

tree命令

还可深入挖掘详细的tree命令用法,输入tree --help

tree命令选项
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容