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.2.tar.gz (3.8 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.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flaskkit-0.1.2.tar.gz
  • Upload date:
  • Size: 3.8 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.2.tar.gz
Algorithm Hash digest
SHA256 18df73bf89f98af4d584ce11c284750f1aa55f0b4a4233d0ce0a2f961ef2f053
MD5 8c76d6319d31d94dc19e80c6ae9e244d
BLAKE2b-256 6b4a3597a20b123e5dc3bb0ac7906a884e27b53da6feb657f8c722c14483a7a5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flaskkit-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 867cb72997313c74538f67a4aed061b196931aaa740956f5e66cd69a74094cd7
MD5 cd4b7bbe9a7aee44b89c80e87ccee8d2
BLAKE2b-256 b320a111b5ad1063565de8f0857d3dfab9430cf2eaa3e017c9c16a0acdcc2c4b

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