Entorno virtual creado

Author: molro

Backend/FastAPI/README.md

@@ -0,0 +1,285 @@
+
+<!-- Improved compatibility of back to top link: See: https://github.com/molro/backend/pull/73 -->
+<a name="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  
+  <h3 align="center">FastAPI - Ejemplo de Uso con Entornos virtuales de Python</h3>
+
+  <p align="center">
+    🎯 Desarrollo de Python con entornos virtuales
+    <br />
+    <a href="https://github.com/molro/backend"><strong>Archivos »</strong></a>
+    <br />
+    <a href="https://github.com/molro/backend/issues">Reportar un bug</a>
+    ·
+    <a href="https://github.com/molro/backend/issues">Asignar una feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<!-- <details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installing </a></li>
+      </ul>
+    </li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details> -->
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About 
+
+Por defecto la instalación de Python, incluye una gran cantidad de librerías de manera nativa y por defecto en la instalación de Python. Sin embargo es habitual el uso de liberías de terceros, como en este caso FastAPI.
+
+Para instalar y manejar paquetes, el módulo pip es la herramienta que nos permite instalar estas librerías de terceros, sin embargo esto lo realiza de manera global. 
+
+Cuando compartimos el código, mediante un repositorio en GitHub por ejemplo, para poder ejecutar la aplicación deberemos instalar todas aquellas librerías de terceros que hemos instalado previamente de manera manual, con el riesgo que eso conlleva. 
+
+Para ello existen dos alternativas:
+* Usar contenedores (Docker por ejemplo)
+* Usar Entornos virtuales 
+
+Porqué?
+* Tu tiempo es valioso y debes enfocarte en crear soluciones para resolver problemas que ayuden a otros.
+* No deberías pasar tiempo instalando y desinstalando versiones de Python una y otra vez por cada proyecto.
+* Deberías implementar el principio KISS para el resto de tu vida y esto es parte de ello :smile:
+
+
+En este tutorial nos enfocaremos en el uso y desarrollo con entornos virtuales.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Backend
+
+Para comenzar el backend esta creado con:
+
+- [![Python][python-shield]][python-url]
+- [![FastApi][fastAPI-shield]][fastAPI-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- GETTING STARTED -->
+## Inicio
+The following tools are prior to follow this tutorial and you will be need it running on your machine, however you can find here is a quickly reminder:
+* [![Docker][docker-shield]][docker-url]
+* [![Git][git-shield]][git-url]
+* [![Postman][postman-shield]][postman-url]
+* Your Favorite IDE
+### Prerequisites
+
+This is quick guide of how to install the tools that we will need to use our pre built backend.
+* Git 
+  * macOS -> Use Homebrew package manager -> [Learn more here][gitMac]
+    ```sh
+      brew install git
+    ```
+  * Linux
+    * For distribution based on Debian/Ubuntu
+      ```sh
+        apt-get install git
+      ```
+    * For Fedora 
+      ```sh
+        yum install git
+      ```
+    For others distributions, visit [Download Git for Linux/Unix][gitLinux]
+
+  * Windows
+
+    You can download the latest 32-bit version [Click Here][gitWindows32bit]<br/>
+    For other downloads, visit [Dowload git for Windows][gitWindows]
+
+* Docker 
+  * macOS 
+
+    * For Mac with Apple silicon [here][dockerapplesilicon]
+    * For Mac with Intel chip [here][dockerappleIntel]
+    
+    For more info visit [Docker Install on Mac][dockermac-url]
+  * Windows  
+    We suggest read this first [Docker install on Windows][windowsDocker-url]
+    
+    You can download clicking [Desktop][windowsdektop-url]
+  
+  * Linux/Unix 
+  
+    You can dowload directly [Docker Desktop][linuxdockerdesktop-url] here and follow the instructions, but you must know that in Linux/Unix you have two options and you can read more here [Docker Desktop or Docker Engine][linuxdocker-url]
+### Installing 
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/molro/backend.git
+   ```
+
+2. Run and stop the backend
+
+   -  Run the backend 
+   ``` sh 
+   docker compose up -d 
+   ```
+   - Stop the backend
+   ``` sh
+   docker compose down 
+   ```
+
+3. Test the endpoints  
+
+    Actually the backend has only two endpoints working
+    
+    1. GET ``` http://127.0.0.1:3009 ``` - Response status 200 and Json. The first time the reponse will be an empty array ```[] ``` 
+    2. POST ``` http://127.0.0.1:3009/crear ``` - Response 200 and OK message and Post a preestablished message 
+    ```sh
+        {
+        "_id": str,
+        "tipo": "Usuario",
+        "estado": "Feliz",
+        "__v": 0
+        }
+    ``` 
+
+4. Code!
+
+    Write your code, make the API-REST growing up or connect with your frontend.
+
+5. Testing your code
+    - Running the application and review the changes
+    ```sh
+    docker compose up -d
+    ```
+    - Stop the application
+    ```sh
+      docker compose down
+    ```
+
+8. Add, Commit and Push! 
+```sh
+    git add . 
+    git commit -m "Your Commit" 
+    git push
+```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [x] Create API-REST version 0.1
+- [x] Create Dockerfile 
+- [x] Create Docker Compose 
+- [x] Build Docker Image 0.1
+- [x] Push image to Docker Hub
+- [x] Create documentation version 0.1 
+- [ ] API-REST version 0.2
+    - [ ] Re-estructure endpoints 
+    - [ ] Implement authorization method  
+    - [ ] Create new docker image
+    - [ ] Push new version of image
+- [ ] Case of uses section
+- [ ] Troubleshooting
+- [ ] Acknowledgments section
+See the [open issues](https://github.com/molro/backend/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GPL License. See [License][license-url] file for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+[![Twitter][twitter-shield]][twitter-url] [![GitHub][github-shield]][github-url]<br/>
+Project Link: [https://github.com/molro/backend](https://github.com/molro/backend)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+
+[python-shield]:https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
+[python-url]: https://www.python.org
+
+[fastAPI-shield]:https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi
+[fastAPI-url]:https://fastapi.tiangolo.com
+
+[nodejs-shield]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
+[node-url]: https://nodejs.org/en/
+[expressjs-shield]: https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB
+[expressjs-url]: https://expressjs.com
+[mongoDB-shield]: https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white
+[mongoDB-url]: https://www.mongodb.com
+[mongoose-shield]: https://img.shields.io/badge/mongoose-6.6.5-red
+[mongoose-url]: https://mongoosejs.com
+[docker-shield]:https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
+[docker-url]: https://www.docker.com
+[git-shield]:https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white
+[git-url]: https://git-scm.com
+
+[postman-shield]:https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white
+[postman-url]: https://www.postman.com
+
+
+[twitter-shield]:https://img.shields.io/twitter/follow/molro?style=social
+[twitter-url]:https://www.twitter.com/molro
+[github-shield]:https://img.shields.io/github/followers/molro?style=social
+[github-url]: https://github.com/molro/
+
+[gitMac]:https://git-scm.com/download/mac
+[gitLinux]:https://git-scm.com/download/linux
+[gitWindows32bit]:https://github.com/git-for-windows/git/releases/download/v2.38.1.windows.1/Git-2.38.1-32-bit.exe 
+[gitWindows]:https://git-scm.com/download/win
+
+[dockerapplesilicon]:https://desktop.docker.com/mac/main/arm64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-mac-arm64
+[dockerappleIntel]:https://desktop.docker.com/mac/main/amd64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-mac-amd64
+[dockermac-url]:https://docs.docker.com/desktop/install/mac-install/
+
+[windowsDocker-url]:https://docs.docker.com/desktop/install/windows-install/#wsl-2-backend
+[windowsdektop-url]:https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe
+
+[linuxdocker-url]:https://docs.docker.com/desktop/faqs/linuxfaqs/#what-is-the-difference-between-docker-desktop-for-linux-and-docker-engine
+[linuxdockerdesktop-url]:https://docs.docker.com/desktop/install/linux-install/
+
+[license-url]:https://github.com/molro/backend/blob/main/LICENSE

Backend/FastAPI/main.py

@@ -6,7 +6,11 @@
 
 # Instala FastAPI: pip install "fastapi[all]"
 
-from fastapi import FastAPI
+from fastapi import FastAPI 
+## Probablemente esto de error o parezca que no importa fastapi - 
+# Se debe a que el interprete de VSCODE esta seleccionado de manera global. 
+# Se puede corregir, seleccionado el interprete ubicado en la ruta venv/bin/python (La ruta de nuestro entorno virtual)
+
 
 app = FastAPI()
 

Backend/FastAPI/requirements-global.txt

@@ -0,0 +1,57 @@
+anyio==3.6.2
+async-generator==1.10
+attrs==22.1.0
+beautifulsoup4==4.11.1
+certifi==2022.6.15
+charset-normalizer==2.1.0
+click==8.1.3
+exceptiongroup==1.0.1
+Flask==2.2.2
+Flask-SQLAlchemy==3.0.2
+gcloud==0.18.3
+googleapis-common-protos==1.56.4
+greenlet==2.0.1
+h11==0.14.0
+httplib2==0.20.4
+idna==3.3
+iniconfig==1.1.1
+itsdangerous==2.1.2
+Jinja2==3.1.2
+jws==0.1.3
+MarkupSafe==2.1.1
+oauth2client==4.1.3
+outcome==1.2.0
+packaging==21.3
+pluggy==1.0.0
+protobuf==4.21.3
+pyasn1==0.4.8
+pyasn1-modules==0.2.8
+pycryptodome==3.15.0
+pydantic==1.10.2
+PyJWT==2.6.0
+pyparsing==3.0.9
+Pyrebase==3.0.27
+Pyrebase4==4.5.0
+PySocks==1.7.1
+pytest==7.2.0
+python-firebase==1.2
+python-jwt==2.0.1
+pytz==2022.6
+requests==2.28.1
+requests-toolbelt==0.9.1
+rsa==4.9
+selenium==4.6.0
+six==1.16.0
+sniffio==1.3.0
+sortedcontainers==2.4.0
+soupsieve==2.3.2.post1
+SQLAlchemy==1.4.43
+starlette==0.22.0
+tomli==2.0.1
+trio==0.22.0
+trio-websocket==0.9.2
+twilio==7.15.4
+typing_extensions==4.4.0
+urllib3==1.26.10
+Werkzeug==2.2.2
+wsproto==1.2.0

Backend/FastAPI/requirements-preinstall.txt

@@ -0,0 +1,16 @@
+anyio==3.6.2
+click==8.1.3
+fastapi==0.88.0
+h11==0.14.0
+httptools==0.5.0
+idna==3.4
+pydantic==1.10.2
+python-dotenv==0.21.0
+PyYAML==6.0
+sniffio==1.3.0
+starlette==0.22.0
+typing_extensions==4.4.0
+uvicorn==0.20.0
+uvloop==0.17.0
+watchfiles==0.18.1
+websockets==10.4