PythonStarterPackage

Paquete de inicio de Python

El propósito de este proyecto es mostrarle cómo crear un paquete Python estándar desde cero. Este proyecto está inspirado en este excelente paquete GetMyip de @iamtennislover: [https://github.com/iamtennislover/getmyip] y esta gran guía sobre la implementación de paquetes de Python por @sigma-coding: [https://github.com/areed1192/sigma-coding].

Consulte pythonstarterpackage_tutorial.md en el directorio doc/ para un tutorial paso a paso sobre cómo implementar un paquete. Si está utilizando este paquete de inicio por primera vez, definitivamente recomiendo hacer el tutorial primero.

Este paquete también se puede usar como esqueleto para cada vez que crea un nuevo paquete. Use las instrucciones a continuación Instalar, probar e implementar el paquete.

A continuación se muestran los recursos GitHub y Pypi para este paquete.

• Repo de Github: https://github.com/Artictechnology/pythonstarterpackage
• Pypi: https://pypi.org/project/pythonstarterpackage/

Requisitos previos

Para Windows, se recomienda ejecutar esta aplicación en una capa de emulación de Linux, como el terminal Git Bash. Consulte la sección "Instrucciones para Git Bash" para más detalles. Además de Git Bash, asegúrese de tener también Python3 y PIP3 como se describe a continuación.

Para Mac y Linux, esta aplicación debe funcionar fuera de la caja en el terminal Linux o Mac, pero asegúrese de tener también Python3 y PIP3 como se describe a continuación.

Requisitos:

• Python3 (versión 3.8 o mayor) - Instale Python3 aquí: [https://www.python.org/downloads/]. Verifique la versión con: python3 --version .
• PIP3 (versión 20.2.1 o mayor): asegúrese de instalar Python3 -PIP para usar la instalación de PIP. Verifique la versión con: pip3 --version .

Instalación

Hay un par de opciones para instalar esta aplicación:

• Instalación de PIP: esta aplicación está alojada en PYPI y se puede instalar con el siguiente comando:

 pip3 install PythonStarterPackage

• Instalación local: alternativamente, puede descargar o clonar Git el repositorio de GitHub e instalarlo localmente con lo siguiente:

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

Para desinstalar esta aplicación:

 pip3 uninstall PythonStarterPackage

• Si usó la opción de instalación local, también querrá eliminar el archivo .egg-info ubicado en el directorio src/ del paquete. Esto se crea automáticamente con pip3 install -e . .

Uso

Después de la instalación, tiene algunas formas de ejecutar esta aplicación.

• Ejecute esta aplicación desde el terminal con este comando:

 pythonstarterpackage

• Ejecute esta aplicación con el comando python python3 -m :

 python3 -m pythonstarterpackage

• También puede importar los recursos del paquete y ejecutarlos en su propio proyecto:

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

Documentación

Para implementar este paquete, primero, asegúrese de haber pasado por Pythonstarterpackage_tutorial.md en el doc/ Directorio. Una vez que comprenda bien cómo implementar su propio paquete y suponiendo que haya asignado dependencias y haya probado el paquete, puede usar lo siguiente para implementar su paquete.

Despliegue

Una vez que el paquete está listo, podemos trabajar en la implementación del paquete.

1. Actualizar setuptools , wheel y twine (se usará twine en la siguiente parte).

 pip3 install --upgrade setuptools wheel twine

2. Construya el paquete con setup.py .

 python3 setup.py sdist bdist_wheel

3. Verifique el contenido de las distribuciones .whl y .tar.gz. Las cosas clave para buscar son: (1) Se agregan todos los subdirectorios de su paquete como UTILS a ambas distribuciones, (2) sus datos de configuración y paquete se incluyen en ambas distribuciones.

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

4. Pruebe una instalación local del paquete y ejecutelo para asegurarse de que esté funcionando.

 pip3 install .
pythonstarterpackage

5. Después de probar que está funcionando, desinstale el paquete de PIP3.

 pip3 uninstall pythonstarterpackage

Si hay algún problema en lo anterior, siempre puede desinstalar el paquete y eliminar las distribuciones, entonces proceda a solucionar el problema. Una vez que comience el principio desde el principio. Los comandos a continuación le permiten eliminar las distribuciones.

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

Tenga cuidado de no malestar el comando anterior, como si elimine algo que no tenía la intención de no poder recuperarlo.

Subir a Pypi

Para cargar a PYPI, asegúrese de configurar primero su cuenta PYPI. Consulte "Guía de configuración de Pypi.md" en doc/ para más detalles. También deberá tener twine instalado y actualizado. Una vez que tenga toda esta configuración, haga lo siguiente:

1. Cargar usando twine .

 twine upload dist/*

2. Instale su paquete con pip .

 pip3 install pythonstarterpackage

Nota: Si obtiene un "requisitos ya satisfechos ..." para PythonStarterPackage al intentar instalar, puede deberse a que pip todavía cree que tiene el paquete ya instalado desde las pruebas anteriormente. Para romper limpiamente esa conexión, simplemente elimine el ./src/PythonStarterPackage.egg-info . Luego intente desinstalar y reinstalar nuevamente.

3. Finalmente, ejecute la aplicación con: pythonstarterpackage .
4. Desinstalar con: pip3 uninstall pythonstarterpackage .

Solución de problemas

Esta sección revisa algunos de los problemas comunes encontrados y cómo resolverlos.

Error de "comando no encontrado" al ejecutar la aplicación

En Linux, si está recibiendo un error command not found al intentar ejecutar la aplicación, es posible que deba agregar ~/.local/bin/ a la ruta. Vea este hilo para más detalles: [https://stackoverflow.com/a/34947489]. Para agregar ~/.local/bin/ a la ruta, haga lo siguiente:

1. Agregar export PATH=~/.local/bin:$PATH a ~/.bash_profile .

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

2. Ejecutar el comando.

 source ~/.bash_profile

"Importador: ningún módulo llamado 'tkinter'

Probablemente le falte a su versión de Python, que generalmente viene predeterminada. Vea esta publicación para más detalles [https://stackoverflow.com/a/25905642]. Instálelo con lo siguiente:

 sudo apt-get install python3-tk

Para Mac, usa esto:

 brew install python-tk

Instrucciones para Git Bash

Para Windows, se recomienda ejecutar esta aplicación en una capa de emulación de Linux como el terminal Git Bash. Estas son las instrucciones para instalar y configurar Git Bash:

1. Vaya a https://git-scm.com/downloads y haga clic en Descargar.

 Version >= 2.34.1

2. Durante la configuración de instalación, asegúrese de incluir OpenSSH. La configuración recomendada debe estar bien:

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

3. Deje la otra configuración de manera predeterminada, haga clic e instale.
4. Abra bash.exe e instale Python3 https://www.python.org/downloads/
5. Proceda a la sección "Instalación" para instalar esta aplicación.

IMPORTANTE: para Windows, use el terminal bash.exe más bien git-bash.exe . Existe un problema conocido con git-bash.exe estropear los comandos de Python os en import os . Vea este hilo para más detalles: [https://stackoverflow.com/a/33623136].

• Puede encontrar la carpeta bash.exe Git en el bin/ directorio. Por ejemplo: si git-bash.exe está aquí C:Program FilesGitgit-bash.exe , entonces debe encontrar bash.exe aquí C:Program FilesGitbinbash.exe .

Apoyo y contribuciones

Nuestro software es de código abierto y gratuita para uso público. Si encontró que alguno de estos reposos es útil y desea apoyar este proyecto financieramente, no dude en donar a nuestra dirección de Bitcoin.

Dirección de bitcoin 1: 1GZQY6HMWSZQXCMBC6UGXKYD5HKPHK1PMF