Skip to main content

Generador de estructura base para proyectos Flask

Project description

🚀 FlaskKit

FlaskKit es una herramienta de línea de comandos (CLI) para generar automáticamente la estructura base de un proyecto Flask modular, con una organización escalaQble, clara y lista para iniciar el desarrollo de cualquier API o aplicación web con Flask.


📦 ¿Qué hace FlaskKit?

Al ejecutar el comando fk, se generará automáticamente una estructura completa con:

  • Carpeta apps/ con módulos que contienen routers.py y db.py
  • Archivo principal de entrada run.py
  • Carpeta config/ con archivo settings.py usando variables de entorno
  • Carpeta conexiones/ con archivo adaptadores.py
  • Estructura preparada para usar Flask, Flask-CORS, y python-dotenv
  • Sistema basado en patrón de fábrica y arquitectura modular para facilitar escalabilidad y mantenimiento

📁 Estructura generada

mi_proyecto/
│
├── run.py
├── .env
├── config/
│   └── settings.py
│
├── conexiones/
│   └── adaptadores.py
│
├── apps/
│   ├── __init__.py
│   ├── modulo1/
│      ├── routers.py
│      └── db.py
│   ├── modulo2/
│      ├── routers.py
│      └── db.py
│   └── ...

🛠️ Instalación
Instala FlaskKit desde PyPI usando pip:
pip install flaskkit

Si tienes varias versiones de Python, puedes usar:
python -m pip install flaskkit


🧪 Uso
Luego de la instalación, usa el comando en la terminal para crear tu proyecto Flask:
flaskkit

Sobre el PATH y el comando flaskkit
Al instalar con pip, el comando flaskkit debería agregarse automáticamente a tu variable de entorno PATH.

Si al ejecutar flaskkit recibes un error de comando no reconocido, asegúrate de que la carpeta de scripts de Python esté en tu PATH.

En Windows, típicamente la carpeta está en:
C:\Users\<tu_usuario>\AppData\Local\Programs\Python\PythonXX\Scripts\


En Linux/macOS suele ser:
~/.local/bin
Agrega la ruta correspondiente a tu variable PATH para que el comando esté disponible desde cualquier lugar.

🚀 Próximas mejoras
Soporte para Blueprints automáticamente generados

Inclusión opcional de bases de datos con SQLAlchemy

Creación automática de entornos virtuales para cada proyecto

👤 Autor
Deiker Castilo
📧 deikerdcastillo@gmail.com


📄 Licencia
MIT License

📌 Proyecto en PyPI
🔗 https://pypi.org/project/flaskkit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flaskkit-0.1.3.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flaskkit-0.1.3-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file flaskkit-0.1.3.tar.gz.

File metadata

  • Download URL: flaskkit-0.1.3.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for flaskkit-0.1.3.tar.gz
Algorithm Hash digest
SHA256 42f08f6b21078455f4b4792552b6bb968065e97eb60bc3bfe2f7672f3e281132
MD5 db7f17d7a31fb0821f00acac01492f93
BLAKE2b-256 a687bed3ff14c0d0d0b17230c5b11a1b355ad4b144716d51f5a6cab746d90b3f

See more details on using hashes here.

File details

Details for the file flaskkit-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: flaskkit-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for flaskkit-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8ab625349a94bf764c18d654a9c6dfc57d9d3e03d70cbc1a8c876978603be2ea
MD5 75c4093a418f64ff01e85ab73eb62232
BLAKE2b-256 8c0a9b6c55d8e8707a1dcf7e34bd029cb94027d0bfe23b9e2deb39770fde1d5a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page