Módulo Pyscaffold en Python

Comenzar con un proyecto de Python suele ser bastante complejo y complicado, ya que implica instalar y configurar algunos archivos. Aquí es donde entra en juego Pyscaffold . Es una herramienta para configurar un nuevo proyecto de Python, es muy fácil de usar y configura su proyecto en menos de 10 segundos. Para usar Pyscaffold, Git es imprescindible , especialmente los usuarios de Windows deben tener instalado «Git Bash». Además, la instalación de PyScaffold también requiere una versión reciente de «herramientas de configuración».
PyScaffold representa internamente cada proyecto de paquete de Python como una estructura de datos de árbol que se relaciona directamente con una entrada de directorio en el sistema de archivos. Este árbol se implementa como un diccionario simple en el que las claves indican la ruta donde se generarán los archivos, mientras que los valores indican su contenido. 
 

Instalación

Para instalar Pyscaffold usando pip, ejecute el siguiente comando que instala la última versión de Pyscaffold: 

pip install --upgrade pyscaffold

En caso de que no tenga pip instalado, consulte este artículo: Cómo instalar el comando pip
PyScaffold también se puede instalar con conda realizando lo siguiente en el símbolo del sistema de Anaconda: 

conda install -c conda-forge pyscaffold

Si ve algo como esto, significa que Pyscaffold se instaló correctamente. 

Configuración del nuevo proyecto

PyScaffold viene con muchas características y valores predeterminados de configuración para facilitar al máximo las tareas frecuentes de desarrollo, mantenimiento y distribución de su propio paquete de Python. 
Para configurar un nuevo proyecto de python, use el comando putup:  

putup Your_Project

Esto crea una carpeta Your_Project con el diseño de proyecto de un proyecto de Python y tiene una carpeta de paquete Your_Project junto con documentos y carpetas de pruebas y los archivos setup.py, setup.cfg, AUTHORS.txt, README.txt y LICENSE.txt. Toda la configuración se realiza en «setup.cfg» en lugar de setup.py. Aquí puede cambiar todas las configuraciones relacionadas con el paquete (es decir, autor, URL, licencia, etc.). Además, para agregar archivos de datos adicionales, podemos agregar sus nombres en setup.cfg y se agregarán automáticamente. 
PyScaffold está diseñado para cubrir los aspectos esenciales de la creación y distribución de paquetes de Python. La mayoría de las veces, configurar las opciones de instalación es suficiente para garantizar la configuración adecuada de un proyecto. PyScaffold se puede ampliar en tiempo de ejecución con otros paquetes de Python. También es posible escribir un script o programa externo que incruste PyScaffold y usarlo para realizar algunas acciones definidas por el usuario.
Ejemplo: 

# Temporarily adjust padding
# while executing a context.
from pyscaffold.log import logger
 
 
logger.report('invoke', 'custom_action')
with logger.indent():
    logger.report('create', 'some / file / path')
 
# Expected logs:
# --------------------------------------
# invoke  custom_action
# create    some / file / path
# --------------------------------------
# Note how the spacing between activity and
# subject in the
# second entry is greater than the equivalent
# in the first one.

Actualizaciones: 

• Siempre que se publique una nueva actualización de PyScaffold, puede usar este comando para actualizar la 
  estructura/andamio de su proyecto: 

output --update my_project

• Una actualización solo actualizará los archivos que el usuario no suele usar o modificar, por lo tanto, para 
  actualizar todos los archivos, use la actualización forzada: 

--update --force

• Nota: 
  • Si está actualizando desde una versión de PyScaffold anterior a la 2.0, debe eliminar manualmente los archivos versioneer.py y MANIFEST.in.
  • Si está actualizando desde una versión anterior a la 2.2, debe eliminar ${PACKAGE}/_version.py.

Cómo migrar a PyScaffold

Inicialmente, el proyecto (digamos my_project) tiene que estar en un repositorio de Git e incluye un paquete (digamos my_package) junto con sus módulos de python.
Nota: Su árbol de trabajo no está sucio, es decir, todos los cambios están comprometidos y todos los archivos importantes están bajo control de versión.

• Comience cambiando a la carpeta principal de my_project y escriba el siguiente comando para implementar la nueva estructura del proyecto en su repositorio. 

putup my_project --force --no-skeleton -p my_package

• Cambie a my_project y mueva la carpeta de su paquete anterior a src con este comando y use la misma técnica si el proyecto tiene una carpeta de prueba que no sea tests o una carpeta de documentación que no sea docs. 

git mv my_package/* src/my_package/

• Use el estado de git para buscar archivos sin seguimiento y agréguelos con git add.
• . Eventualmente, use git difftool para verificar todos los archivos sobrescritos en busca de cambios que deban transferirse. Toda la configuración que haya realizado en setup.py debe trasladarse a setup.cfg. En la mayoría de los casos, no necesitará realizar cambios en el nuevo archivo setup.py proporcionado por PyScaffold.
• Ejecute estos comandos para comprobar que todo funciona: 

run python setup.py install and python setup.pysdist

• También ejecute python setup.py docs y python setup.py test para comprobar que Sphinx y PyTest se ejecutan correctamente.