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