如何建立一家公司网站,网站导航栏代码,外贸网站建设要求,上海注册公司免费地址一、关于Python项目结构Python 项目并没有完全统一的 “固定结构”#xff0c;但行业内有一些广泛遵循的约定俗成的目录结构#xff08;尤其针对可分发的包或大型项目#xff09;。同时#xff0c;确实有工具可以快速生成这些标准化结构#xff0c;提高开发效率#xff0…一、关于Python项目结构Python 项目并没有完全统一的 “固定结构”但行业内有一些广泛遵循的约定俗成的目录结构尤其针对可分发的包或大型项目。同时确实有工具可以快速生成这些标准化结构提高开发效率这在实际开发中非常常见。对于需要打包、发布或多人协作的项目典型结构如下对于简单脚本或小项目结构可以简化例如只有 src/ 目录和几个核心文件。二、快速生成项目结构的工具Cookiecutter今天我们介绍一下最流行的项目模板工具Cookiecutter支持通过模板快速生成标准化结构不仅限于 Python。Cookiecutter 是一个由 Audrey Roy Greenfeld开源社区活跃开发者发起并主导开发的开源项目其核心维护团队包括多位社区贡献者并非由特定商业公司作为 “发行人” 或 “ publisher ” 进行官方发布。2.1、安装cookiecutter如果要安装到虚拟化环境下在虚拟化终端执行“pip install cookiecutter”命令2.2、调用标准模板运行cookiecutter https://github.com/audreyr/cookiecutter-pypackagePython 包标准模板前提是能访问github。提示执行改命令要提前安装了git在宿主机上安装即可并将git.exe所在目录添加到了path环境变量中。如果已经创建过项目的话cookiecutter会在本地创建缓存模板这样的话可以直接用本地的用法有
cookiecutter C:\Users\yourname\.cookiecutters\cookiecutter-pypackage或者
cookiecutter cookiecutter-pypackage系统会自动从默认的缓存路径 ~/.cookiecutters/ 下去寻找名为 cookiecutter-pypackage 的模板。如果长时间用本地的模板源有更新了可以在联网时用下面的命令更新本地模板
cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git --overwrite-if-exists下载的模板文件默认缓存在本地的如下目录下2.3、创建项目结构接下来根据模板要求一次输入下面的full_name可以是作者名称团队名称git上的用户名或者昵称依次输入下面的名称各字段的含义我列个表提示信息含义示例回答重要性full_name作者/维护者的全名会写入版权和作者信息Haitao Luo⭐⭐⭐⭐⭐email作者的联系邮箱your.emailexample.com⭐⭐⭐⭐⭐github_username您的 GitHub 用户名your-github-username⭐⭐⭐⭐project_name项目的正式名称可以包含空格给人看的My Awesome Project⭐⭐⭐⭐⭐project_slug项目的短标识用于包名、目录名电脑看的my_awesome_project⭐⭐⭐⭐⭐pypi_username您在 PyPI 上的用户名如果打算发布your-pypi-username⭐⭐project_short_description项目的一句话简短描述A Python package that does awesome things.⭐⭐⭐⭐version项目的初始版本号0.1.0⭐⭐⭐use_pytest是否使用 pytest 作为测试框架y (推荐)⭐⭐⭐use_pypi_deployment_with_travis是否配置 Travis CI 自动发布到 PyPIn (除非您明确需要)⭐add_pyup_badge是否添加 Pyup 安全更新徽章n (可选)⭐command_line_interface是否添加命令行接口CLIClick (推荐) 或 Argparse 或 No⭐⭐漏了一个pypi_package_name 就是您的包在“Python应用商店”PyPI里的“商品名”需要独一无二且便于用户查找和安装。创建结束后可以看到左侧树上有了对应的项目结构并在windows资源管理器查看Cookiecutter创建项目结构说明1. 核心目录名称说明src/源代码根目录。这是现代 Python 打包PyPA推荐的结构。您的实际包package就在这里的某个文件夹下。这种结构可以避免无意中导入本地其他文件而非已安装的包。tests/测试代码目录。存放所有单元测试和集成测试文件。通常与 src/ 下的模块结构一一对应例如 src/mypackage/core.py 的测试文件是 tests/test_core.py。docs/项目文档目录。通常使用 Sphinx 或 MkDocs 来构建项目的详细文档。.github/GitHub 工作流配置。里面通常有 workflows/ 文件夹存放 GitHub Actions 的 YAML 配置文件用于实现CI/CD持续集成/持续部署如自动运行测试、自动发布等。2. 配置文件关键文件名称说明pyproject.toml现代Python项目的核心配置文件。取代了旧的 setup.py。它定义了项目构建依赖如setuptools、项目元数据名称、版本、作者、以及各种工具如pytest、black、flake8的配置。这是最重要的文件之一。LICENSE开源许可证。规定了他人使用您代码的权利和义务。常见的有MIT、Apache 2.0、GPL等。README.md项目首页文档。这是项目的门面通常包含项目介绍、安装方法、快速使用示例、贡献指南等。在GitHub和PyPI上会直接显示。.gitignoreGit忽略规则。指定哪些文件或目录不应该被纳入版本控制如虚拟环境 venv/、编译缓存 __pycache__/、IDE配置等。MANIFEST.in打包附加文件清单。当构建分发包sdist时pyproject.toml 可能不会自动包含所有非代码文件如文档、静态资源。这个文件用来指明需要额外包含哪些文件。.editorconfig编辑器配置。帮助在不同编辑器和IDE之间保持代码风格如缩进、字符集的一致性。3. 文档与规范文件名称说明CODE_OF_CONDUCT.md行为准则。规定了社区交流合作的规范为所有贡献者创造一个友好的环境。CONTRIBUTING.md贡献指南。详细说明如何为项目做贡献如如何提交Issue、如何拉取请求Pull Request、代码风格要求等。HISTORY.md更新日志。记录每个版本的重大变更、新增功能和修复的Bug。justfileJust命令运行器配置。just 是一个类似 make 的命令运行工具用于定义和管理项目常用的命令如运行测试、构建文档、格式化代码等。这是一个可选但很方便的工具。需要注意的是此时的venv虚拟化环境和通过cookiecutter创建的项目是同一目录级别这种情况下是一个虚拟化环境适配多个project如果想做个项目隔离那么venv虚拟化目录在你创建的project里面这个换一篇再介绍。
