# pyproject_demo

**Repository Path**: yangfanimb/pyproject_demo

## Basic Information

- **Project Name**: pyproject_demo
- **Description**: No description available
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-12
- **Last Updated**: 2021-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pyproject_demo

#### 介绍
{**以下是 Gitee 平台说明，您可以替换此简介**
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}

#### 软件架构
my_project/
|-- bin/    存放项目的一些可执行文件，当然你可以起名script/之类的也行，但bin/更直观。易懂
|   |-- __init__
|　 |-- start.py   写启动程序
|
|-- core/   存放项目的所有源代码(核心代码）。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。 (2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
|   |-- tests/  
|   |   |-- __init__.py
|   |   |-- test.main.py 
|   |
|   |-- __init__.py
|   |-- main.py    存放核心逻辑 
|
|-- conf/    配置文件
|   |-- __init__.py
|   |-- setting.py   写上相关配置
|
|---db/    数据库文件
|   |--db.json    写数据库文件
|  
|-- docs/   存放一些文档
|  
|-- lib/   库文件，放自定义模块和包
|   |-- __init__.py
|   |-- common.py    放常用的功能
|
|-- log/   日志文件
|   |-- access.log    写上日志
|
|-- __init__.py
|-- README    项目说明文件
|-- requirements.txt

#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

LICENSE 协议文件， 可以参考这篇文章 https://www.jianshu.com/p/a57c13631d5e，讲的很详细了

README.md 项目介绍，一般包括使用的环境，安装的方法，软件的基本原理、测试数据及常见问题等，越详细越好

requirements.txt 记录依赖的软件包及对应的版本号，方便读者明确项目使用了哪些Python包，可以使用命令安装所有的依赖包pip install -r requirements.txt，另外，可以使用pipreqs这个工具来生成requirements.txt

setup.py 管理代码的打包、安装、部署问题， 可以参考之前的文章 https://xugaoxiang.com/2018/07/24/%E8%AF%A6%E8%A7%A3python%E4%B8%AD%E7%9A%84setup.py/

ChangeLog.txt 记录版本发布的release note

.gitignore 如果使用的是git代码管理工具，表明上传时忽略的文件，如果您使用的是svn，请忽略

docs 文档目录，项目配置文件通常也放在这里，关于项目配置文件，可以看看这篇文章，讲的比较全 https://martin-thoma.com/configuration-files-in-python/

extras 有时候会使用到一些C/C++库，一般放在这个文件夹里

scripts 存放脚本文件，比如代码仓库不适合存放很大的二进制文件，这时候可以写个脚本去拉取

1.  运行程序时，在bin目录下执行start.py代码，不可以直接执行core下的模块。  

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)