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 ：您當前正在讀取的文件。