Inicio>Recursos para la creación de sitios web>Datos del sitio web
Descargar

Frasco

Flaskel es un esqueleto para todo tipo de aplicación Flask con API REST o no.

Características

  • Esqueleto de aplicación: 
    flaskel init --help
  • Fábrica de aplicaciones avanzadas, ver: flaskel.builder.AppBuilder
  • Soporte para pruebas con el paquete flaskel.tester
  • Colección de extensiones internas y externas bien integradas
  • Colección de vistas a frascos personalizados
  • admite múltiples servidores WSGI, pero Gunicorn está bien compatible con
  • Ejecutar la aplicación a través de CLI con muchas opciones
  • Mejor configuración a través de múltiples fuente: módulo, YAML (o JSON), variables ENV
  • Mejor soporte HTTP para el cliente y el servidor, consulte: flaskel.http

Extensiones

Las extensiones están registradas a través de AppBuilder, ver: flaskel.scripts.skeleton.ext

Extensiones de terceros:

  • Matraces
  • Chaleco
  • Frascos
  • Frasco
  • Frasco
  • Frascos
  • Maillar
  • Frascos
  • Frasco

Mis propias extensiones externas:

  • Flask-CloudflarereMote (CloudFlareRemote)
  • Flask-errorshandler (errores_handler)
  • Flask-Logify (Logify)
  • Flask-ResponseBuilder (Respuesta_Builder)
  • Flask-TemplatesUpport (Template_Support)

Extensiones internas:

  • flaskel.ext.crypto.argon.Argon2 (argon2)
  • flaskel.ext.datetime.FlaskDateHelper (date_helper)
  • flaskel.ext.ipban.FlaskIPBan (Ipban)
  • flaskel.ext.redis.FlaskRedis (Redis)
  • flaskel.ext.useragent.UserAgent (useragent)
  • flaskel.ext.redis.FlaskRedis (Redis)
  • flaskel.ext.sendmail.ClientMail (client_mail) extiende frasco-mail
  • flaskel.ext.jobs.APJobs (Scheduler) extiende Flask-Spcheduler
  • flaskel.ext.mongo.FlaskMongoDB (Mongo) extiende Flask-Pymongo
  • flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), Verificaciones predeterminadas: Glances, Mongo, Redis, Sqlalchemy, System, Services (HTTP API)

Extensiones de envoltura:

  • flaskel.ext.caching.Cache envuelve el colapso de frascos
  • flaskel.ext.limit.RateLimit envolturas Limitador Flask
  • flaskel.ext.auth.DBTokenHandler , fraskel.ext.auth.redistokenhandler wraps frask-jwt

Extensiones adicionales:

  • flaskel.extra.mobile_support.MobileVersionCompatibility (mobile_version)
  • flaskel.extra.stripe.PaymentHandler (Stripe)

Vistas

Flaskel viene con vistas útiles para las API más comunes o controladores web simples:

  • flaskel.views.base.BaseView
  • flaskel.views.rpc.JSONRPCView
  • flaskel.views.template.RenderTemplate
  • flaskel.views.template.RenderTemplateString
  • flaskel.views.base.Resource
  • flaskel.views.resource.CatalogResource
  • flaskel.views.resource.Restful
  • flaskel.views.resource.PatchApiView
  • flaskel.views.proxy.ProxyView
  • flaskel.views.proxy.ConfProxyView
  • flaskel.views.proxy.TransparentProxyView
  • flaskel.views.proxy.JsonRPCProxy
  • flaskel.views.proxy.SchemaProxyView
  • flaskel.views.static.StaticFileView
  • flaskel.views.static.SPAView
  • flaskel.views.token.BaseTokenAuth

Vistas adicionales:

  • flaskel.extra.apidoc.ApiDocTemplate
  • flaskel.extra.apidoc.ApiSpecTemplate
  • flaskel.extra.media.ApiMedia
  • flaskel.extra.media.GetMedia
  • flaskel.extra.mobile_support.MobileReleaseView

Soporte de sqlalchemy

Flaskel viene con componentes de auxiliares de Sqlalchemy:

  • Schema de volcado a través de CLI: 
    flaskel schema --help
  • clase de modelo personalizado que agrega funcionalidades a todos los modelos 
 class SQLAModel ( Model ):
    def columns ( self ): ...
    def get_one ( cls , raise_not_found = True , to_dict = True , * args , ** kwargs ): ...
    def get_list ( cls , to_dict = True , restricted = False , order_by = None , page = None , page_size = None , max_per_page = None , * args , ** kwargs ): ...
    def query_collection ( cls , params = None , * args , ** kwargs ): ...
    def update ( self , attributes ): ...

Estructuras de datos 

 class ConfigProxy : ...
class ExtProxy : ...

Soporte de Webargs 

 from flaskel import webargs

@ webargs . query (...)
...

@ webargs . payload (...)
...

@ webargs . query_paginate ()
...

webargs . paginate ()

webargs . Field . integer ()
webargs . Field . string ()
webargs . Field . decimal ()
webargs . Field . boolean ()
webargs . Field . positive ()
webargs . Field . not_negative ()
webargs . Field . not_positive ()
webargs . Field . negative ()
webargs . Field . isodate ()
webargs . Field . list_of ()

webargs . OptField . integer ()
webargs . OptField . string ()
webargs . OptField . decimal ()
webargs . OptField . boolean ()
webargs . OptField . positive ()
webargs . OptField . not_negative ()
webargs . OptField . not_positive ()
webargs . OptField . negative ()
webargs . OptField . isodate ()
webargs . OptField . list_of ()

webargs . ReqField . integer ()
webargs . ReqField . string ()
webargs . ReqField . decimal ()
webargs . ReqField . boolean ()
webargs . ReqField . positive ()
webargs . ReqField . not_negative ()
webargs . ReqField . not_positive ()
webargs . ReqField . negative ()
webargs . ReqField . isodate ()
webargs . ReqField . list_of ()

Soporte de esquema JSON 

 class PayloadValidator :
    schemas = SCHEMAS
    validator = JSONSchema

    @ classmethod
    def validate ( cls , schema , strict = True ): ...

Configuración

Hay muchas claves de configuración proporcionadas por muchas fuentes, se anulan la misma clave en una fuente diferente. Prioridades de origen (bajo a alto):

  • Módulo de Python: todos los valores predeterminados frass.config
  • Mapeo (dict): a través de CLI desde el archivo YAML o JSON
  • Módulo Python: a través de la variable de entorno APP_CONFIG_FILE
  • Variables de entorno: manejadas a través de python-decouple , por lo que se puede almacenar en el archivo .env o settings.ini

Configuración a través de Env:

  • DEBUG : (predeterminado: bool = true)
  • TESTING : (predeterminada: bool = depuración)
  • APP_NAME : (default = fraskel)
  • APP_HOST : (default = 127.0.0.1)
  • APP_PORT : (predeterminado: int = 5000)
  • FLASK_APP : (default = App: App)
  • SERVER_NAME : (default = app_host: app_port)
  • FLASK_ENV : (predeterminado = desarrollo)
  • LOCALE : (default = "en_en.utf8")
  • JWT_ALGORITHM : (default = "hs512")
  • JWT_ACCESS_TOKEN_EXPIRES : (predeterminado: 1 día)
  • JWT_REFRESH_TOKEN_EXPIRES : (predeterminado: 14 días)
  • TEMPLATES_AUTO_RELOAD : (predeterminado: bool = debug)
  • EXPLAIN_TEMPLATE_LOADING : (predeterminado: bool = falso)
  • SEND_FILE_MAX_AGE_DEFAULT : (predeterminado: 1 día)
  • APIDOCS_ENABLED : (predeterminado: bool = true)
  • CONF_PATH : (default = fraskel/scripts/skeleton/res)
  • SQLALCHEMY_DATABASE_URI : (default = sqlite: ///db.sqlite)
  • REDIS_URL : (default = mongodb: // localhost)
  • REDIS_CONN_TIMEOUT : (predeterminado: float = 0.05)
  • MONGO_URI : (default = redis: //127.0.0.1: 6379)
  • MONGO_CONN_TIMEOUT_MS : (predeterminado: int = 100)
  • MONGO_SERVER_SELECTION_TIMEOUT_MS : (predeterminado: int = 100)
  • BASIC_AUTH_USERNAME : (default = admin)
  • BASIC_AUTH_PASSWORD : (default = admin)
  • ADMIN_EMAIL : (default = admin)
  • ADMIN_PASSWORD : (default = admin)
  • MAIL_DEBUG : (predeterminado: bool = debug)
  • MAIL_SERVER : (default = sendria.local)
  • MAIL_PORT : (predeterminado: int = 62000)
  • MAIL_USERNAME : (predeterminado: "")
  • MAIL_PASSWORD : (predeterminado: "")
  • MAIL_USE_SSL : (predeterminado: bool = falso)
  • MAIL_USE_TLS : (predeterminado: bool = falso)
  • MAIL_DEFAULT_SENDER : (default = [email protected])
  • MAIL_DEFAULT_RECEIVER : (default = [email protected])
  • MAIL_RECIPIENT : (predeterminado: [email protected])
  • MAIL_TIMEOUT : (predeterminado: int = 60)
  • PREFERRED_URL_SCHEME : (default = http si frask_env = desarrollo más https)
  • LOG_BUILDER : (default = text)
  • LOG_APP_NAME : (default = app_name)
  • LOG_LOGGER_NAME : (default = frask_env)
  • LOG_REQ_SKIP_DUMP : (default = no prueba)
  • LOG_RESP_SKIP_DUMP : (default = no prueba)
  • LOG_RESP_HEADERS : (default = [])
  • LOG_REQ_HEADERS : (default = [])
  • CF_STRICT_ACCESS : (default = false)
  • VERSION_STORE_MAX : (default = 6)
  • VERSION_CACHE_EXPIRE : (predeterminado = 60)
  • HTTP_PROTECT_BODY : (default = false)
  • HTTP_DUMP_REQ_BODY : (default = false)
  • HTTP_DUMP_RESP_BODY : (default = false)
  • HTTP_SSL_VERIFY : (default = true)
  • HTTP_TIMEOUT : (predeterminado = 10)
  • USE_X_SENDFILE : (default = no depuración)
  • ENABLE_ACCEL : (predeterminado = true)
  • WSGI_WERKZEUG_LINT_ENABLED : (predeterminado = prueba)
  • WSGI_WERKZEUG_PROFILER_ENABLED : (predeterminado = prueba)
  • WSGI_WERKZEUG_PROFILER_FILE : (default = "Profiler.txt")
  • WSGI_WERKZEUG_PROFILER_RESTRICTION : *(predeterminado: list = [0.1])
  • SQLALCHEMY_ECHO : (predeterminado = prueba)
  • JSONRPC_BATCH_MAX_REQUEST : (default = 10)
  • IPBAN_ENABLED : (predeterminado = true)
  • IPBAN_KEY_PREFIX : (default = app_name)
  • IPBAN_KEY_SEP : (default = /)
  • IPBAN_BACKEND : (predeterminado = local)
  • IPBAN_BACKEND_OPTS : (default = {})
  • IPBAN_COUNT : (predeterminado = 5)
  • IPBAN_SECONDS : (predeterminado = 3600)
  • IPBAN_NET_WHITELIST : (default = 127.0.0.0/8)
  • IPBAN_IP_WHITELIST : (default = 127.0.0.1)
  • IPBAN_STATUS_CODE : (default = 403)
  • IPBAN_CHECK_CODES : (predeterminado = 404,405,501)
  • RATELIMIT_ENABLED : (default = no depuración)
  • RATELIMIT_HEADERS_ENABLED : (default = true)
  • RATELIMIT_IN_MEMORY_FALLBACK_ENABLED : (default = true)
  • RATELIMIT_STORAGE_URL : (default = redis_url)
  • RATELIMIT_KEY_PREFIX : (default = app_name)
  • SCHEDULER_AUTO_START : (default = true)
  • SCHEDULER_API_ENABLED : (default = false)
  • CACHE_KEY_PREFIX : (default = app_name)
  • CACHE_REDIS_URL : (default = redis_url)
  • CACHE_DEFAULT_TIMEOUT : (predeterminado = 1 hora)
  • CACHE_DISABLED : (predeterminado = falso)

Configuración de la aplicación estática:

  • ERROR_PAGE : (default = "core/error.html")
  • DATABASE_URL : (default = sqlalchemy_database_uri)
  • SECRET_KEY_MIN_LENGTH : (predeterminado: int = 256)
  • PRETTY_DATE : (default = " %d %b %y %i: %m %p")
  • DATE_ISO_FORMAT : (default = "%y-%m-%dt%h:%m:%s")
  • JWT_DEFAULT_SCOPE : (default = none)
  • JWT_DEFAULT_TOKEN_TYPE : (default = "bearer")
  • JWT_TOKEN_LOCATION : (default = ["encabezados", "query_string"])
  • HTTP_DUMP_BODY : (predeterminado: [falso, falso])
  • ACCEL_BUFFERING : (default = true)
  • ACCEL_CHARSET : (default = "UTF-8")
  • ACCEL_LIMIT_RATE : (default = "Off")
  • RB_DEFAULT_ACCEPTABLE_MIMETYPES : (default = ["Application/Json", "Aplicación/XML"])
  • REQUEST_ID_HEADER : (default = "x-request-id")
  • CACHE_TYPE : (default = "frask_caching.backends.redis")
  • CACHE_OPTIONS : (dict)
  • CORS_EXPOSE_HEADERS : (lista)
  • RATELIMIT_STORAGE_OPTIONS : (dict)
  • SCHEDULER_JOBSTORES : (dict)
  • SCHEDULER_EXECUTORS : (dict)
  • SCHEDULER_JOB_DEFAULTS : (dict)
  • LIMITER : (dict)
    • FAIL : (default = "1/segundo")
    • FAST : (default = "30/minuto")
    • MEDIUM : (default = "20/minuto")
    • SLOW : (default = "10/minuto")
    • BYPASS_KEY : (default = "x-limiter-bypass")
    • BYPASS_VALUE : (default = "bypass-rate-limit")

Las configuraciones adicionales se cargan opcionalmente a través de archivos en la carpeta CONF_PATH :

  • APISPEC : (Swagger.yaml)
  • SCHEMAS : (schemas.yaml)
  • SCHEDULER_JOBS : (Scheduler.yaml)
  • LOGGING : (log.yaml) Si falta, predeterminado flaskel.utils.logger:LOGGING

Configuración específica para extensiones internas:

  • Flaskel.ext.crypto.argon.argon2

    • ARGON2_ENCODING : (default = utf-8)
    • ARGON2_TIME_COST : (default = 3)
    • ARGON2_HASH_LEN : (default = 32)
    • ARGON2_PARALLELISM : (predeterminado = 4)
    • ARGON2_SALT_LEN : (predeterminado = 16)
    • ARGON2_MEMORY_COST : (predeterminado = 65536) 64 mib
    • ARGON2_PROFILE : (predeterminado = bajo) permitido bajo | alto

  • Flaskel.ext.healthcheck.health.healthcheck

    • HEALTHCHECK_ABOUT_LINK : (predeterminado = ninguno)
    • HEALTHCHECK_VIEW_NAME : (default = HealthCheck)
    • HEALTHCHECK_PATH : (default = /HealthCheck)
    • HEALTHCHECK_PARAM_KEY : (default = comprobación)
    • HEALTHCHECK_PARAM_SEP : (default = +)
    • HEALTHCHECK_CONTENT_TYPE : (default = Application/Health+JSON)

  • Flaskel.ext.datetime.FlaskdateHelper

    • DATE_HELPER_COUNTRY : (default = it)
    • DATE_HELPER_PROV : (default = none)
    • DATE_HELPER_STATE : (default = none)
    • DATE_ISO_FORMAT : (default = "%y-%m-%dt%h:%m:%s")
    • DATE_PRETTY : (default = " %d %b %y %i: %m %p")

  • Flaskel.ext.jobs.apjobs

    • SCHEDULER_AUTO_START : (default = false)
    • SCHEDULER_PATCH_MULTITHREAD : (default = true)
    • SCHEDULER_LOCK_FILE : (default = .scheduler.lock)

  • Flaskel.ext.ipban.Flaskipban

    • IPBAN_ENABLED : (predeterminado = true)
    • IPBAN_KEY_PREFIX : (default = app_name)
    • IPBAN_KEY_SEP : (default = /)
    • IPBAN_BACKEND : (predeterminado = local)
    • IPBAN_BACKEND_OPTS : (default = {})
    • IPBAN_COUNT : (predeterminado = 5)
    • IPBAN_SECONDS : (predeterminado = 3600)
    • IPBAN_NET_WHITELIST : (default = 127.0.0.0/8)
    • IPBAN_IP_WHITELIST : (default = 127.0.0.1)
    • IPBAN_STATUS_CODE : (default = 403)
    • IPBAN_CHECK_CODES : (predeterminado = 404,405,501)

  • Flaskel.ext.caching.caching

    • CACHE_TYPE : (default = "frask_caching.backends.redis")
    • CACHE_REDIS_URL : (default = redis_url)
    • CACHE_DEFAULT_TIMEOUT : (default = Seconds.hour)
    • CACHE_KEY_PREFIX : (default = app_name)
    • CACHE_OPTIONS : (DICT) Pasado a la instancia del cliente Redis

  • Flaskel.ext.redis.flaskredis

    • REDIS_URL : (default = redis: // localhost: 6379/0)
    • REDIS_OPTS : (DICT) Pasado a la instancia del cliente de Redis

  • Flaskel.ext.Mongo.FlaskMongoDB

    • MONGO_URI : (default = mongodb: // localhost)
    • MONGO_OPTS : (dict) Pasado a la instancia del cliente MongoDB

  • Flaskel.ext.useragent.useragent

    • USER_AGENT_AUTO_PARSE : (default = false)

  • Flaskel.extra.stripe.paymentHandler (Stripe)

    • STRIPE_SECRET_KEY :
    • STRIPE_PUBLIC_KEY :
    • STRIPE_WEBHOOK_SECRET :
    • STRIPE_DEBUG : (predeterminado = falso)
    • STRIPE_DEFAULT_CURRENCY : (default = eur)
    • STRIPE_API_VERSION : (predeterminado = 2020-08-27)

  • Flaskel.extra.Mobile_Support.MobileVersionCompatibility (mobile_version)

    • VERSION_STORE_MAX : (default = 6)
    • VERSION_CACHE_EXPIRE : (default = 3600)
    • VERSION_CHECK_ENABLED : (default = true)
    • VERSION_AGENT_HEADER : (default = x-agent)
    • VERSION_API_HEADER : (default = X-API-Version)
    • VERSION_STORE_KEY : (default = x_upgrade_needed)
    • VERSION_HEADER_KEY : (default = x-mobile-version)
    • VERSION_UPGRADE_HEADER : (default = x-upgrade necesario)
    • VERSION_AGENTS : (default = (Android, iOS))
    • VERSION_SKIP_STATUSES : (default = (Probidden, Not_Found, Method_Not_Alowed, Too_Many_Requests)))

  • Flaskel.extra.notification.NotificationHandler

    • FCM_API_KEY : obligatorio si se usa

  • Flaskel.extra.media.service.mediaservice

    • MEDIA : (dict)
      • ALLOWED_EXTENSIONS : (predeterminado: [png, jpg])
      • UPLOAD_FOLDER :
      • EXTERNAL_URL :
Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo