JoJo's API

JoJo's API es un proyecctos realizado en:

Python

Con el micro-framework:

Flask

Requisitos

Para correr la aplicacion es nesesario tener:

Instalacion

Nota: Recomiendo crear un entorno virtual ( venv ) para usar esta aplicacion.

Crear entornor virtual

  • Usar esta comando para crear el entorno virtual dentro del directorio.
python -m venv ./venv

Nota: En caso de ejecutar el comando en bash/zsh, usar python3

  • Activar entorno virtual.

Para Windows:

.\venv\Scripts\activate.bat

Para Linux/Mac:

source ./venv/bin/activate

Instalar dependencias

  • Usa el gestor de paquetes pip para instalar todas las dependecias del proyectos con el siguiente comando.
pip install -r requirements.txt

Nota: En caso de usar bash/zsh, usar el comando pip3

Configuracion

Archivo .flaskenv

  • Cambiar el nombre del archivo .flaskenv

  • Cambiar la URI de la base de datos.

# MySQL URI
export SQLALCHEMY_DB_URI=mysql+pymysql://<user>:<password>@localhost/jojosdb

# SQLite (Default)
export SQLALCHEMY_DB_URI=sqlite:///jojosdb

Nota: En las etiquetas y . Colocar las crendenciales del usuario de la base de datos (El usuario debe de contar con permisos apra creartablas e insetar data)

  • Cambiar puerto.
export FLASK_RUN_PORT=5000

Cambiar base de datos SQLite a otra MySQL o MariaDB

  • Crear la base de datos con esta linea de comando.
CREATE DATABASE jojosdb;

Nota: Solo si habeis cambiado la URI en el archivo de configuracion, por default se creara una base de datos SQLite.

  • Para usar la base de datos MySQL es nesesario instalar esta dependencia.
pip install pymysql==1.0.2

Nota: Confirme que tenga habilitado en entorno vitual antes creado.

Migraciones

Crear migraciones de los modelos

  • Una vez creada la base de datos (en caso de haber vambiado la URI), ejecutar las siguientes lineas en al terminal con el entorno vitual habilitado para crear las migraciones en la base de datos.
flask db init
flask db migrate
flask db upgrade

Ejecutar servidor

  • Finalmente, ejecutar la aplicacion.
flask run