diff --git a/docs/_static/images/tema_01/folder-access.png b/docs/_static/images/tema_01/folder-access.png new file mode 100644 index 0000000..97f3b8b Binary files /dev/null and b/docs/_static/images/tema_01/folder-access.png differ diff --git a/docs/_static/images/tema_01/open-folder.png b/docs/_static/images/tema_01/open-folder.png new file mode 100644 index 0000000..2f37f27 Binary files /dev/null and b/docs/_static/images/tema_01/open-folder.png differ diff --git a/docs/_static/images/tema_01/py-vers.png.jpg b/docs/_static/images/tema_01/py-vers.png similarity index 100% rename from docs/_static/images/tema_01/py-vers.png.jpg rename to docs/_static/images/tema_01/py-vers.png diff --git a/docs/_static/images/tema_01/tec-prog.png b/docs/_static/images/tema_01/tec-prog.png new file mode 100644 index 0000000..9df13b3 Binary files /dev/null and b/docs/_static/images/tema_01/tec-prog.png differ diff --git a/docs/_toc.yml b/docs/_toc.yml index fc4d507..8a861e9 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -6,13 +6,13 @@ chapters: - file: temas/uno/instalar_cpp_tools - file: temas/uno/instalar_vsc - file: temas/uno/instalar_python - - file: temas/uno/definir_reqs + - file: temas/uno/configuracion + - file: temas/uno/fastapi - file: tema_02 sections: - file: temas/dos/wip - # - file: complejidad_algoritmica # sections: # - file: temas/notacion_asintotica diff --git a/docs/temas/uno/configuracion.md b/docs/temas/uno/configuracion.md new file mode 100644 index 0000000..5d7fc6d --- /dev/null +++ b/docs/temas/uno/configuracion.md @@ -0,0 +1,40 @@ +# Configuraciones finales + +## Espacio de trabajo + +Es importante tener un espacio de trabajo organizado y limpio para poder trabajar de manera eficiente y sin confusiones. +Lo normal es tener un directorio principal o carpeta donde se almacenen más carpetas definidas como proyectos independientes entre sí. En este curso, usaremos Visual Studio Code (VSC) como editor de código, por lo que es importante tener una estructura de carpetas clara y ordenada. + +Lo primero que necesitamos es crear un directorio o carpeta donde ubicaremos todo el contenido y proyectos que desarrollemos en el curso. Para ello, sigue los siguientes pasos: + +1. Pulsa `win + e`, busca un directorio cómodo para ti y crea una carpeta con un nombre reconocible. + + Copiamos la ruta de la carpeta. +2. Abrimos nuestro Visual Studio Code (VSC) y pulsamos `ctrl + k o`. Pegamos la ruta de la carpeta y pulsamos `enter`. + + + ```{tip} + Alternativamente puedes arrastrar la carpeta hasta el editor de código en VSC, al soltarla se abrirá dicha carpeta. + ``` + +3. Sólo si confías en tí mismo, acepta la advertencia de confianza pulsando en **Sí, confío en los autores**. + +4. Puedes comprobar con `ctrl + e` en el **Explorador de archivos** que has abierto el directorio padre. + +```{dropdown} Desafío 00! +Vamos a generar un proyecto cuyo nombre será `Mini-Back`, al terminar debemos abrirlo. El reto está en hacerlo sólo por terminal. +``` + +## Extensiones de Visual Studio Code + +Las extensiones de Visual Studio Code (VSC) son herramientas que nos permiten extender las funcionalidades del editor de código. Existen extensiones para todo tipo de lenguajes de programación, herramientas de depuración, control de versiones, entre otros. + +Presionamos `ctrl + shift + x` para abrir la pestaña de **Extensiones** y buscamos las siguientes extensiones: + +1. **Python** de Microsoft. +2. **Pylance** de Microsoft. +3. **Live Share** de Microsoft. +4. **Thunder Client** de Thunder Client. +5. **Code Runner** de Jun Han. +6. **Ruff** de Astral Software. +7. **Dotenv Official + Vault** de Dotenv. diff --git a/docs/temas/uno/definir_reqs.md b/docs/temas/uno/definir_reqs.md deleted file mode 100644 index 79b1937..0000000 --- a/docs/temas/uno/definir_reqs.md +++ /dev/null @@ -1,11 +0,0 @@ -# Definición de requerimientos - -Hola. - -~~~powershell -comando de powershell -~~~ - -```{tip} -Bash almacena temporalmente los comandos! -``` diff --git a/docs/temas/uno/fastapi.md b/docs/temas/uno/fastapi.md new file mode 100644 index 0000000..b7d5fc9 --- /dev/null +++ b/docs/temas/uno/fastapi.md @@ -0,0 +1,70 @@ +# Introducción a FastAPI + +Ya que nos encontramos en la carpeta `Mini-Back`, vamos a entender FastAPI como un framework web moderno y rápido para crear APIs con Python 3.6+ *(3.6 en adelante)* basado en estándares abiertos y estándares de tipo de datos Python. Es fácil de aprender y usar, pero también es muy rápido y eficiente. + +Lo primero que debemos hacer es configurar correctamente nuestro entorno de desarrollo, esto aplica para cualquier desarrollo que se realice en Python + +## Entorno virtual + +Un entorno virtual es un directorio que tiene como función aislar todas las librerías, módulos y dependencias para un proyecto en particular. Esto se hace porque cada proyecto puede tener diferentes versiones de las librerías y módulos, y a veces pueden ser incompatibles entre sí. + +Para crear un entorno virtual, debemos instalar la librería `virtualenv` que nos permitirá crear un entorno virtual. Para ello, abrimos una terminal y ejecutamos el siguiente comando: + +```powershell +pip install virtualenv +``` + +Una vez instalado `virtualenv`, vamos a crear un entorno virtual en la carpeta `Mini-Back`. Para ello, ejecutamos el siguiente comando: + +```powershell +python -m venv .venv +``` + +```{note} +Si usamos `ctrl + shift + p` y escribimos `Python: Create Environment`, seleccionamos la opción `Python: Select Interpreter` y elegimos la opción `Create New Environment`, seleccionamos Venv y finalmente la versión de Python que deseemos. +``` + +*El uso de `-m` es para especificar un módulo, en este caso `venv` que es el módulo que nos permite crear entornos virtuales y así no tomar otro módulo que se pueda llamar igual.* +Este comando creará un directorio llamado `.venv` en la carpeta `Mini-Back`. No obsatante **debemos activar siempre** el entorno virtual *(se desactiva al cerrar el editor)*, ejecutamos el siguiente comando: + +```powershell +.venv\Scripts\activate +``` + +Podremos notar cómo en la terminal aparece el nombre del entorno virtual activo, en este caso `(.venv)`. En caso se necesite desactivar el entorno virtual, se ejecuta el comando: + +```powershell +deactivate +``` + +## Requerimientos + +En desarrollos colaborativos, es importante tener un archivo que contenga todas las librerías y módulos que se necesitan para ejecutar el proyecto. Para ello, vamos a crear un archivo llamado `requirements.txt` en la carpeta raíz (`Mini-Back`) y vamos a agregar las siguientes librerías: + +```text +fastapi +uvicorn +pydantic +python-dotenv +ruff +``` + +```{note} +En python 3.8+ se puede usar `pip freeze > requirements.txt` para habiendo ya instalado las dependencias, generar este archivo `requirements.txt` con todas las librerías instaladas en el entorno virtual. +```{dropdown} Más sobre versionamiento! +Si no espacificamos la versión en las librerías, se instalará la última versión disponible. +Para especificar una versión exacta, se puede hacer de la siguiente manera: + +```plaintext +fastapi==0.68.0 +uvicorn>=0.15.0,<=0.17.0 +pydantic<1.8.2 +python-dotenv>=0.19.0 +ruff~=0.1.0 +``` + +```{note} +instalación de Python aislada de la instalación global. Esto significa que los paquetes instalados en el entorno virtual no afectarán a la instalación global y viceversa. +``` + +Ahora sí vamos a instalar FastAPI, para ello, abrimos una terminal y ejecutamos el siguiente comando: diff --git a/docs/temas/uno/instalar_python.md b/docs/temas/uno/instalar_python.md index 6ad6974..011394e 100644 --- a/docs/temas/uno/instalar_python.md +++ b/docs/temas/uno/instalar_python.md @@ -12,7 +12,7 @@ Para instalar Python en tu computadora, sigue los siguientes pasos: 1. Abre el navegador y accede a la página de descarga de [Python Windows](https://www.python.org/downloads/windows/). 2. Descarga el instalador de Python y ejecútalo *(puedes descargar más de una versión e instalarlas paulatinamente)*. - + 3. Asegúrate de seleccionar la opción de **Add Python to PATH**. 4. Haz clic en "Install Now" y espera a que finalice la instalación. 5. Abre una terminal *(busca cmd en Windows o usa `win + r`, escribe `cmd` y pulsa `enter`)* y ejecuta el siguiente comando para validar todas las versiones de Python que se hayan instalado en tu computadora: @@ -41,7 +41,6 @@ py -0p :::: - ```{tip} Si eres usuario Windows es posible instalar Python a través de la Microsoft Store, para ello busca Python en la tienda (en la versión deseada) y sigue los pasos de instalación. ```