美文网首页
GitHub 创建python项目(.gitignore LIC

GitHub 创建python项目(.gitignore LIC

作者: 别动我名字呀 | 来源:发表于2019-05-20 16:28 被阅读0次

    Get started by creating a new file or uploading an existing file. We recommend every repository include a README, LICENSE, and .gitignore.
    解释:
    开始通过创建一个新文件或上传现有文件。我们建议每个存储库都包含README、LICENSE和.gitignore。


    README.md

    • 必要的项目介绍、使用及代码结构

    使用markdown语法:参考https://www.jianshu.com/p/b03a8d7b1719


    LICENSE

    开放源代码许可协议(版权声明),没有用过,这里不做介绍


    .gitignore

    • 用于项目下的所有开发者都共享的,一套定义好的,忽略特殊文件规则。

    Git忽略文件的原则:

    • 忽略操作系统自动生成的文件,比如缩略图等;
    • 忽略编译生成的中间文件、可执行文件等,也就是如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库,比如Java编译产生的.class文件;
    • 忽略你自己的带有敏感信息的配置文件,比如存放口令的配置文件。

    如下是一个合适python开发的规则:

    # 忽略Windows自动在有图片的目录下生成隐藏的缩略图文件,如果有自定义目录,则忽略目录下的Desktop.ini文件:
    Thumbs.db
    ehthumbs.db
    Desktop.ini
    
    
    # 忽略Python编译产生的.pyc、.pyo、dist等文件或目录,以及日志:
    *.log
    *.py[cod]
    *.so
    *.egg
    *.egg-info
    .idea/
    dist
    build
    
    # My configurations 自定义文件:
    db.ini
    deploy_key_rsa
    
    

    规则:

    ##注释##:注释
    /文件夹/ :过滤文件夹
    *.xml :过滤某类型的文件
    /mtk/do.c:指定过滤具体文件
    !开头表示不过滤
     *.[oa]    支持通配符:过滤repo中所有以.o或者.a为扩展名的文件
    

    参考:https://www.liaoxuefeng.com/wiki/896043488029600/900004590234208


    requirements.txt python项目特有的文件

    • 记录当前程序的所有依赖包及版本号,其作用是用来在另一个环境上重新构建项目所需要的运行环境依赖。如:
    Django == 2.0.3
    PyYAML == 3.12
    requests == 2.18.4
    eventlet == 0.22.1
    mysqlclient == 1.3.12
    django-celery == 3.2.2
    flower == 0.9.2
    

    详细参考:python requirements.txt使用方法

    相关文章

      网友评论

          本文标题:GitHub 创建python项目(.gitignore LIC

          本文链接:https://www.haomeiwen.com/subject/mhwkzqtx.html