Introducción

PyFabricate es una aplicación de Mac OS X que simplifica la creación de proyectos de Python. Desde que lo escribí, obviamente es una versión obstinada de cómo creo que debería ser un proyecto de Python. Además, tengo un determinado conjunto de herramientas que utilizo para permitirme escribir aplicaciones Python para Mac OS X. Sin embargo, intenté crear un poco de personalización exponiendo las plantillas a partir de las cuales creo archivos de proyecto. Más sobre esto más adelante.

Descripción general

PyFabricate utiliza una interfaz similar a un asistente para consultar los detalles del proyecto.

Suposiciones con opiniones

• El desarrollador utiliza HomeBrew para instalar las dependencias obstinadas.

  • Python se administra a través de pyenv (para usar en los entornos virtuales creados)
  • direnv está instalado (opcional)

• El nombre del proyecto es el mismo que el nombre del paquete del módulo

Instalación

Obtenga la versión actual desde aquí.

Copie este archivo a la carpeta de aplicaciones de su Mac OS. La aplicación está firmada con código de Apple, por lo que recibirá un mensaje simple que deberá reconocer la primera vez que la ejecute.

Detalles del esqueleto del proyecto

El siguiente es un ejemplo del esqueleto inicial que crea PyFabricator. Ahora muestra el entorno virtual que crea. Más sobre esto más adelante.

Esencialmente, PyFabricate crea los directorios src y tests. En el directorio raíz del proyecto crea los siguientes archivos:

• .envrc
• .gitignore
• .mypi.ini
• .python_version
• .LICENCIA
• README.md
• pyproject.toml
• requisitos.txt

Además, PyFabricate crea todos los archivos del paquete Python (__init__.py) en todos los lugares apropiados. Y finalmente, coloca dos conjuntos de archivos de configuración de registro, uno para su aplicación y otro para sus pruebas unitarias.

Al final de la fabricación, PyFabricate crea un entorno virtual Python. Debido a limitaciones técnicas, PyFabricate no puede utilizar una versión pyenv de Python para crear el entorno virtual. Por lo tanto, depende de una versión casera instalada.

Interfaz de usuario del asistente

La interfaz de usuario del asistente es un proceso de 4 pasos en el que PyFabricate recopila suficientes detalles del proyecto que utiliza para completar las plantillas de esqueleto. Las plantillas utilizan los siguientes tokens de sustitución que se explican por sí mismos.

El siguiente es un gráfico anotado de la plantilla pyroject.toml.

Paso 1 de la interfaz de usuario del asistente: Introducción

Este paso es una introducción a PyFabricate. Después de este paso, PyFabricate hace todo lo posible para garantizar que se cumplan sus dependencias de ejecución. De lo contrario, el desarrollador no puede continuar con este paso.

Paso 2 de la interfaz de usuario del asistente: Detalles del proyecto

En este paso, PyFabricate recopila información específica del proyecto. La mayor parte de esto sirve para completar la plantilla pyproject.toml.

Paso 3 de la interfaz de usuario del asistente: directorio base

PyFabricate supone que el desarrollador mantiene todos sus proyectos de Python en un único subdirectorio. Esta es una opinión obstinada y es simplemente una preferencia organizacional.

Paso 4 de la interfaz de usuario del asistente: versión Python

PyFabricate consulta a pyenv para conocer las versiones de Python instaladas por el desarrollador. Estos son los únicos a partir de los cuales PyFabricate puede crear entornos virtuales Python.

Registro de acciones

Al final del asistente, PyFabricate presenta un registro mientras crea el proyecto. El siguiente es un registro de ejemplo.

Personalización

Como se mencionó anteriormente, el desarrollador puede personalizar algunos aspectos de la generación del proyecto. PyFabricate almacena las plantillas que utiliza en $HOME/.config/pyfabricate/templates como se indica a continuación.

Por ejemplo, es posible que un desarrollador desee utilizar una licencia diferente. Simplemente reemplace el archivo LICENSE.template

Envolver

PyFabricate actualmente solo está en la versión 0.5.0. Actualmente estoy investigando cómo agregar funciones adicionales y eliminar limitaciones.