GitHub 创建python项目(.gitignore LICENSE README.md...)的了解

了解如何在GitHub上创建Python项目,包括必备的README.md(项目介绍和代码结构)、LICENSE(开放源代码许可协议)、.gitignore(忽略特定文件)和requirements.txt(记录依赖包版本)。.gitignore遵循原则,忽略操作系统生成文件、编译产物和敏感信息。requirements.txt用于记录项目依赖,便于环境复现。
摘要由CSDN通过智能技术生成

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.
以下是Python项目中常用的.gitignore文件内容: ``` # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging dist/ build/ eggs/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py *.sage.py~ # Environments .env .venv env/ venv/ ENV/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值