PythonStarterPackage

Python入門包

該項目的目的是向您展示如何從頭開始創建標準的Python軟件包。該項目的靈感來自@iamtennislover的出色getMyip包：[https://github.com/iamtennislover/getmyip]，以及這份關於 @sigma-coding部署Python軟件包的精彩指南：[https://github.com/areed1192/sigma-coding]。

有關如何部署軟件包的分步教程，請參見doc/ DICERTORY中的PythonStarterPackage_tutorial.md。如果您是第一次使用此入門包，我絕對建議您先做教程。

每次創建新軟件包時，此軟件包也可以用作骨架。使用以下說明安裝，測試和部署軟件包。

以下是此軟件包的GitHub和PYPI資源。

• github repo：https：//github.com/arctictechnology/pythonstarterpackage
• PYPI：https：//pypi.org/project/pythonstarterpackage/

先決條件

對於Windows，建議在Linux仿真層（例如Git Bash終端）上運行此應用程序。有關詳細信息，請參見“ Git Bash的說明”部分。除了git bash，請確保您還具有python3和pip3，如下所述。

對於Mac和Linux，該應用程序應在Linux或Mac終端上的框中奏效，但是請確保您還具有python3和pip3，如下所述。

要求：

• Python3（版本3.8或更高版本） - 在此處安裝Python3：[https：//www.python.org/downloads/]。檢查版本： python3 --version 。
• PIP3（版本20.2.1或更高版本） - 確保安裝Python3 -PIP以使用PIP安裝。檢查版本： pip3 --version 。

安裝

安裝此應用程序有幾個選項：

• PIP安裝 - 此應用程序託管在PYPI上，可以使用以下命令安裝：

 pip3 install PythonStarterPackage

• 本地安裝 - 另外，您可以下載或git克隆GitHub存儲庫，並在本地安裝以下內容：

 git clone https://github.com/ArcticTechnology/PythonStarterPackage.git
cd PythonStarterPackage
pip3 install -e .

卸載此應用程序：

 pip3 uninstall PythonStarterPackage

• 如果您使用了本地安裝選項，則還需要刪除位於軟件包的src/ Directory中的.egg-info文件。使用pip3 install -e . 。

用法

安裝後，您有幾種運行此應用程序的方法。

• 使用此命令從終端運行此應用：

 pythonstarterpackage

• 使用Python命令python3 -m ：運行此應用程序：

 python3 -m pythonstarterpackage

• 您還可以導入包資源並將其運行在您自己的項目中：

 from pythonstarterpackage import *
starter = StarterPkg()
starter.run()

文件

首先，要部署此軟件包，請確保您已經通過doc/ DICERTORY中的PythonStarterPackage_tutorial.md進行了。一旦您對如何實現自己的軟件包有很好的了解並假設您已經映射了依賴項並測試了軟件包，則可以使用以下內容來部署軟件包。

部署

包裝準備好後，我們可以部署包裝。

1. 升級setuptools ， wheel和twine （下一部分將使用twine ）。

 pip3 install --upgrade setuptools wheel twine

2. 使用setup.py構建軟件包。

 python3 setup.py sdist bdist_wheel

3. 檢查.WHL和.TAR.GZ發行版的內容。要查找的關鍵內容是：（1）您的所有軟件包子目錄（例如UTILS）都添加到兩個分佈中，（2）您的配置和軟件包數據都包含在兩個分佈中。

 unzip -l dist/*.whl && tar --list -f dist/*.tar.gz

4. 測試軟件包的本地安裝並運行它以確保其正常工作。

 pip3 install .
pythonstarterpackage

5. 測試它正在工作後，請從PIP3卸載包裝。

 pip3 uninstall pythonstarterpackage

如果上述問題上有任何問題，您始終可以卸載包裝並刪除分佈，然後繼續對問題進行故障排除。一旦從頭開始完成。下面的命令允許您刪除分佈。

 rm -rf build dist src/*.egg-info

請注意不要錯過上述命令，就好像您刪除了您不打算的東西一樣，您將無法檢索它。

上傳到PYPI

為了上傳到PYPI，請確保首先設置您的PYPI帳戶。有關更多詳細信息，請參見doc/中的“ PYPI設置指南”。您還需要安裝和升級twine 。一旦您擁有所有這些設置，請執行以下操作：

1. 使用twine上傳。

 twine upload dist/*

2. 使用pip安裝包裹。

 pip3 install pythonstarterpackage

注意：如果您在嘗試安裝時獲得了pythonstarterpackage的“已經滿足的需求...”，則可能是因為pip仍然認為您已經從測試中已經安裝了包裝。要清潔該連接，只需刪除./src/PythonStarterPackage.egg-info即可。然後嘗試重新安裝並重新安裝。

3. 最後，使用： pythonstarterpackage運行該應用程序。
4. 卸載： pip3 uninstall pythonstarterpackage 。

故障排除

本節介紹了發現的一些常見問題以及如何解決這些問題。

運行應用程序時“找不到”錯誤

在Linux上，如果嘗試運行應用程序時command not found錯誤，則可能需要將~/.local/bin/添加到路徑中。有關詳細信息，請參見此主題：[https://stackoverflow.com/a/34947489]。要添加~/.local/bin/到路徑上，請執行以下操作：

1. 添加export PATH=~/.local/bin:$PATH到達~/.bash_profile 。

 echo export PATH=~/.local/bin:$PATH > ~/.bash_profile

2. 執行命令。

 source ~/.bash_profile

“ Importerror：沒有名為'tkinter'的模塊

您的Python版本可能缺少tkinter，通常默認情況下。有關詳細信息[https://stackoverflow.com/a/25905642]。以以下方式安裝它：

 sudo apt-get install python3-tk

對於Mac，請使用以下方式：

 brew install python-tk

Git Bash的說明

對於Windows，建議在Git Bash終端等Linux仿真層上運行此應用程序。這是安裝和設置Git Bash的說明：

1. 轉到https://git-scm.com/downloads，然後單擊下載。

 Version >= 2.34.1

2. 在安裝設置期間，請確保包括OpenSSH。建議的設置應該可以：

 Use bundled OpenSSH - This uses ssh.exe that comes with Git.

3. 將其他設置作為默認設置，單擊並安裝。
4. 打開bash.exe並安裝python3 https://www.python.org/downloads/
5. 繼續進入“安裝”部分以安裝此應用程序。

重要的是：對於Windows，請使用bash.exe終端而不是git-bash.exe 。 git-bash.exe在import os中弄亂了Python os命令。有關詳細信息，請參見此主題：[https://stackoverflow.com/a/33623136]。

• 您可以在bin/目錄中找到bash.exe git文件夾。例如：如果git-bash.exe在這裡C:Program FilesGitgit-bash.exe ，則應該在此處找到bash.exe C:Program FilesGitbinbash.exe 。

支持和貢獻

我們的軟件是開源的，可以免費使用。如果您發現這些存儲庫中的任何一個有用並希望在財務上支持該項目，請隨時捐贈給我們的比特幣地址。

比特幣地址1：1GZQY6HMWSZQXCMBC6UGXKYD5HKPHK1PMF