python项目结构及相关文件编写
一、简介
这里介绍进行python项目开发时，项目的目录结构和相关文件编写。这里的相关文件主要指requirements.txt文件和README.md文件。
二、python项目结构
1、python项目组合部分
python项目主要包括以下几部分：
bin: 可执行文件;
docs: 项目文档;
项目名: 这里就是具体的项目代码;
tests: 测试代码;
README.md: 项目介绍;
requirements.txt: python项目依赖包定义;
2、结构示意如下：
项目名
｜
｜－－bin
｜
｜－－docs
｜
｜－－项目名
｜ ｜
｜ ｜－－main.py
｜
｜－－tests
｜
｜－－README.md
｜
｜－－requirements.txt三、requirements.txt文件
requirements.txt是定义项目依赖的python包，可通过工具生成。工具可以生成两种依赖包定义，
一是项目依赖的python包，二是所在python环境安装的python包。
1、生成项目依赖包步骤
a、安装pipreqs工具，命令：sudo pip3 install pipreqs
b、到项目根目录下，命令： pipreqs ./
这时就会生成requirements.txt文件
2、生成整个当前python环境安装的python包
到项目根目录下，直接运行：pip3 freeze > requirements.txt
3、requirements.txt安装
命令：pip3 install -r requirements.txt
四、README.md文件
README.md文件用于介绍项目内容和使用。编写遵守一定语法，下面进行简要介绍。
1、多个=或-来标识标题
a、在文字下一行，编写多个=，可标识大标题;
a、在文字下一行，编写多个，可标识中标题;
如：
大标题
==
中标题
--效果：
2、多个#标识不同级别的标题
#个数从1到6个，分别标识6个级别的标题，如：
#1级标题
##2级标题
###3级标题
####4级标题
#####5级标题
######6级标题效果：
3、列表
多个*和空格标识简单列表，如：
item:
* 1
* 1.1
* 1.1.1
* 2数据加空格标识有序列表，如：
num list:
1. item1
2. item2效果：
4、多个>标识不同级别的缩进
如：
>缩进1格
>>缩进2格
>>>缩进3格
>>>>缩进4格效果：
5、通过
或者行末加两个空格标识换行
如：
第1行
第2行,通过html标签换行
第3行,通过句末有两个空格换行
第4行 效果：
6、通过` `或** **标识文字强调
简单`强调`
加粗**字体**效果：
7、添加文字链接或添加图片
通过[]()来标识文字链接，通知![]()添加图片，如：
简单[链接](https://pypi.org/project/readme-md/)
图片显示效果：
8、代码或区域标识
通过``` ```进行区域标识，同时可指定代码类型，如：
#####简单区域
```
readme
```
#####python代码
```python
print('readme') #代码注释
```
#####java代码
```java
System.out.print("readme"); //代码注释
```
#####javascript代码
```javascript
console.log("readme"); //代码注释
```
#####bash代码
```bash
echo 'readme' #代码注释
```效果：
9、完整示例如下：
项目标题
==
###### 项目简介
##列表展示
#####简单列表
item:
* 1
* 1.1
* 1.1.1
* 2
#####有序列表
num list:
1. item1
2. item2
##横线标题
大标题
==
中标题
--
##标题使用
#1级标题
##2级标题
###3级标题
####4级标题
#####5级标题
######6级标题
##内嵌模块书写
#####简单区域
```
readme
```
#####python代码
```python
print('readme') #代码注释
```
#####java代码
```java
System.out.print("readme"); //代码注释
```
#####javascript代码
```javascript
console.log("readme"); //代码注释
```
#####bash代码
```bash
echo 'readme' #代码注释
```
##链接使用
简单[链接](https://pypi.org/project/readme-md/)
图片显示
##缩进使用
>缩进1格
>>缩进2格
>>>缩进3格
>>>>缩进4格
##换行
第1行
第2行,通过html标签换行
第3行,通过句末有两个空格换行
第4行
##文字强调
简单`强调`
加粗**字体**