template package importable

概述

这是我们在创建新的基于Python的导入软件包时内部使用的软件包模板。它具有创建，构建和发布新软件包所需的所有基本功能和工作流程。

该软件包模板没有提供任何CLI功能，而是旨在创建可导入的软件包的设计。

我们决定将其与其他工具一起提供，以允许人们在创建自己的工具时使用精心设计的起点。

我们还提供了我们使用的其他两个模板。

• 模板Python项目
• 模板软件包CLI

特征

• 模块化体系结构：将代码组织到模块中，以更好地可维护性。
• 自定义异常：用于实现特定错误处理的自定义异常的基本示例。
• 测试示例：为包装编写pytest测试的基本示例。

安装

要安装可导入的软件包，请克隆存储库并导航到项目目录：

git clone https://github.com/DevelopersToolbox/template-package-importable.git
cd template-package-importable

建议使用虚拟环境来管理依赖关系。您可以使用以下命令创建和激活虚拟环境：

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

安装所需的依赖项：

pip install -r requirements.txt

项目结构

该项目的组织如下：

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable ：包含应用程序的核心模块。
  • exceptions.py ：处理自定义异常。
  • functions.py ：定义一些示例函数（用于测试）。
• tests ：Pytest测试所在的位置。
  • test_template_package_importable.py ：要运行的特定测试。
• setup.py ：软件包配置。
• requirements.txt ：列出项目所需的依赖项。
• README.md ：您当前正在读取的文件。