Haz que tu proyecto de Python Flask sea instalable

Introducción

En este laboratorio, aprenderemos a hacer que un proyecto de Python Flask sea instalable. Esto permitirá desplegar y administrar el proyecto utilizando herramientas estándar de Python. Este proceso es beneficioso ya que permite instalar el proyecto en diferentes entornos, administrar las dependencias y aislar los entornos de prueba.

Nota: Debes crear el archivo de código por ti mismo y ejecutarlo en el entorno. Puedes previsualizar el estado del servicio Flask en el Web 5000.

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL flask(("Flask")) -.-> flask/CoreConceptsGroup(["Core Concepts"]) flask(("Flask")) -.-> flask/DevelopmentToolsGroup(["Development Tools"]) flask(("Flask")) -.-> flask/DataHandlingGroup(["Data Handling"]) flask/DataHandlingGroup -.-> flask/incoming_request_data("Incoming Request Data") flask/DataHandlingGroup -.-> flask/response_objects("Response Objects") flask/CoreConceptsGroup -.-> flask/application_object("Application Object") flask/DevelopmentToolsGroup -.-> flask/command_line_interface("Command Line Interface") subgraph Lab Skills flask/incoming_request_data -.-> lab-136341{{"Hacer que el proyecto sea instalable"}} flask/response_objects -.-> lab-136341{{"Hacer que el proyecto sea instalable"}} flask/application_object -.-> lab-136341{{"Hacer que el proyecto sea instalable"}} flask/command_line_interface -.-> lab-136341{{"Hacer que el proyecto sea instalable"}} end

Describir el proyecto

Primero, necesitamos crear un archivo pyproject.toml para describir nuestro proyecto y cómo construirlo.

El archivo pyproject.toml debería verse así:

## pyproject.toml

[project]
name = "flaskr" ## nombre del proyecto
version = "1.0.0" ## versión del proyecto
dependencies = [
    "flask", ## dependencias del proyecto
]

[build-system]
requires = ["setuptools"] ## sistema de compilación requerido
build-backend = "setuptools.build_meta" ## sistema de compilación de backend

Incluir archivos necesarios

El backend de compilación de setuptools necesita otro archivo llamado MANIFEST.in para incluir archivos no Python en el proyecto.

Crea un MANIFEST.in con el siguiente contenido:

## MANIFEST.in

include flaskr/schema.sql
graft flaskr/static
graft flaskr/templates
global-exclude *.pyc

Esto le indica a la compilación que copie todo en los directorios static y templates, y el archivo schema.sql, mientras que excluye todos los archivos de bytecode.

Instalar el proyecto

A continuación, usaremos pip para instalar el proyecto en el entorno virtual.

Ejecute el siguiente comando en su terminal:

pip install -e.

Esto le indica a pip que busque pyproject.toml en el directorio actual e instale el proyecto en modo editable o de desarrollo. El modo editable significa que cuando realice cambios en su código local, solo necesitará volver a instalar si cambia los metadatos del proyecto.

Para verificar la instalación, use el comando pip list:

pip list

La salida debe mostrar el proyecto instalado y sus dependencias.

Resumen

En este laboratorio, aprendimos a hacer que un proyecto de Python Flask sea instalable. Comenzamos describiendo el proyecto e incluyendo los archivos necesarios. Luego, instalamos el proyecto en un entorno virtual. Ahora, el proyecto se puede ejecutar desde cualquier ubicación, no solo desde el directorio del proyecto.