Configuración de un entorno de desarrollo¶
Contribuir a BeeWare requiere que configures un entorno de desarrollo.
Requisitos previos¶
Necesitarás instalar los siguientes requisitos previos.
{{ nombre_formal }} requiere Python 3.10+. También
necesitarás un método para gestionar entornos virtuales (tal como venv).
Puedes verificar la versión de Python que tienes instalada ejecutando:
$ python3 --version
Si tiene más de una versión de Python instalada, es posible que tenga que
sustituir python3 por un número de versión específico (p.ej., python{{ versión_python_reciente }})
Recomendamos evitar las versiones recientes de Python (e.d., las versiones que tienen un micro número de versión ".0" o ".1", como p.e., 3.14.0). Esto se debe a que las herramientas necesarias para soportar Python en macOS a menudo no están disponibles para las versiones estables de Python recientemente publicadas.
{{ nombre_formal }} requiere Python 3.10+. También
necesitarás un método para gestionar entornos virtuales (tal como venv).
Puedes verificar la versión de Python que tienes instalada ejecutando:
$ python3 --version
Si tiene más de una versión de Python instalada, es posible que tenga que
sustituir python3 por un número de versión específico (p.ej., python{{ versión_python_reciente }})
Recomendamos evitar las versiones recientes de Python (e.d., las versiones que tienen un micro número de versión ".0" o ".1", como p.ej., 3.14.0). Esto se debe a que las herramientas necesarias para soportar Python en Linux a menudo no están disponibles para las versiones estables de Python recientemente publicadas.
{{ nombre_formal }} requiere Python 3.10+. También
necesitarás un método para gestionar entornos virtuales (tal como venv).
Puedes verificar la versión de Python que tienes instalada ejecutando:
C:\...>py -3 --version
Si tienes instalada más de una versión de Python, puede que necesites sustituir
-3 por un número de versión específico (p.e., -python3.13)
Recomendamos evitar las versiones recientes de Python (e.d., las versiones que tienen un micro número de versión ".0" o ".1", como p.ej., 3.14.0). Esto se debe a que las herramientas necesarias para soportar Python en Windows a menudo no están disponibles para las versiones estables de Python recientemente publicadas.
Configura tu entorno de desarrollo¶
La forma recomendada de configurar tu entorno de desarrollo para BeeWare es utilizar un entorno virtual, y luego instalar la versión de desarrollo de BeeWare y sus dependencias.
Clonar el repositorio BeeWare¶
A continuación, ve a la página BeeWare de GitHub y, si aún no lo has hecho, bifurca el repositorio en tu propia cuenta. A continuación, pulsa en el botón "<> Code" de tu bifurcación. Si tienes instalada la aplicación de escritorio de GitHub en tu equipo, puedes seleccionar "Abrir con GitHub Desktop"; en otro caso, copia la URL HTTPS proporcionada, y utilízala para clonar el repositorio en tu equipo utilizando la línea de comandos:
Bifurca el repositorio BeeWare, y luego:
$ git clone https://github.com/<your username>/beeware.git
(sustituir tu identificador de GitHub)
Bifurca el repositorio BeeWare, y luego:
$ git clone https://github.com/<your username>/beeware.git
(sustituir tu identificador de GitHub)
Bifurca el repositorio BeeWare, y luego:
C:\...>git clone https://github.com/<your username>/beeware.git
(sustituir tu identificador de GitHub)
Establecer un repositorio ascendente¶
Tras clonar tu bifurcación, añade el repositorio BeeWare como un upstream
remoto. Esto le da a tu clon local una referencia al repositorio original,
haciéndolo más fácil sincronizar actualizaciones a lo largo del tiempo.
También necesitarás etiquetas desde upstream tales que las herramientas como
Toga y Briefcase puedan resolver números de versión precisos:
$ git remote add upstream https://github.com/beeware/beeware.git
$ git fetch --tags upstream
$ git remote add upstream https://github.com/beeware/beeware.git
$ git fetch --tags upstream
C:\...>git remote add upstream https://github.com/beeware/beeware.git
C:\...>git fetch --tags upstream
Si quieres que tu bifurcación también incluya esas etiquetas, puedes subirlas a:
$ git push --tags
Esto puede ser útil si más adelante creas un nuevo clon y deseas que las etiquetas estén disponibles desde tu bifurcación.
Crea un entorno virtual¶
Para configurar un entorno virtual y subir la versión de pip, ejecute:
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Tu solicitud ahora tendría un prefijo (.venv) delante.
Instalar BeeWare¶
Ahora que tienes el código fuente, puedes hacer una instalación editable de BeeWare en tu entorno de desarrollo. Ejecute el siguiente comando:
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
Activar pre‐commit¶
BeeWare utiliza una herramienta llamada pre-commit para identificar incidencias simples y estandarizar el formato del código. Para ello, instala un hook git que ejecuta automáticamente una serie de linters de código antes de finalizar cualquier commit git. Para activar pre-commit, ejecuta:
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
¡Ahora estás listo para empezar a hackear BeeWare!