Page d'accueil>Ressources de création de sites Web>Données du site Web
Télécharger

Flasque

Flaskel est un squelette pour tous les types d'applications FLASK avec des API REST ou non.

Caractéristiques

  • Squelette d'application: 
    flaskel init --help
  • Advanced App Factory, voir: flaskel.builder.AppBuilder
  • Prise en charge des tests avec flaskel.tester Package
  • Collection d'EXT interne et d'EX externe bien intégré
  • Collection de vues de balles personnalisées
  • Prise en charge de plusieurs serveurs WSGI, mais Gunicorn est bien pris en charge
  • Exécutez l'application via CLI avec de nombreuses options
  • meilleure configuration via plusieurs source: module, yaml (ou json), variables env
  • Meilleur support HTTP pour le client et le serveur, voir: flaskel.http

Extensions

Les extensions sont enregistrées via AppBuilder, voir: flaskel.scripts.skeleton.ext

Extensions de tiers:

  • Flask-apcheduler
  • Cache de flacon
  • Cols
  • Flask-httpauth
  • Flacon
  • Limiteur de flacon
  • Balade
  • Flacon
  • Flacon-pymongo

Mes propres extensions externes:

  • Flask-CloudflareReremote (CloudFlarereMote)
  • FLASK-ERRORSHANDLER (ERRORS_HANDLER)
  • FLASK-LOGIFY (Logify)
  • FLASK-RESPONNEBUILDER (Response_Builder)
  • FLASK-TEMPATEUPPORT (Template_Support)

Extensions internes:

  • 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) étend Flask-Mail
  • flaskel.ext.jobs.APJobs (planificateur) étend Flask-Apscheduler
  • flaskel.ext.mongo.FlaskMongoDB (Mongo) étend Flask-Pymongo
  • flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), chèques par défaut: regards, Mongo, redis, sqlalchemy, système, services (API HTTP)

Extensions de wrapper:

  • flaskel.ext.caching.Cache s'envalie
  • flaskel.ext.limit.RateLimit enveloppe Flask-Limiter
  • flaskel.ext.auth.DBTokenHandler , flaskel.ext.auth.redistokenhandler enveloppe Flask-jwt

Extensions supplémentaires:

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

Vues

Flaskel est livré avec des vues utiles pour les API les plus courantes ou les contrôleurs 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

Vues supplémentaires:

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

SQLALCHEMY Soutien

Flaskel est livré avec des composants auxiliaires de Sqlalchemy:

  • Déchargement du schéma via CLI: 
    flaskel schema --help
  • Classe de modèle personnalisée qui ajoute des fonctionnalités à tous les modèles 
 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 ): ...

Structures de données 

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

Prise en charge des 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 ()

Support de schéma JSON 

 class PayloadValidator :
    schemas = SCHEMAS
    validator = JSONSchema

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

Configuration

Il existe de nombreuses touches de configuration fournies par de nombreuses sources, la même clé dans différentes source est remplacée. Priorités source (faible à haut):

  • Module Python: tous par défaut Flaskel.config
  • mappage (dict): via la CLI à partir du fichier yaml ou json
  • Module Python: via l'environnement variable APP_CONFIG_FILE
  • Variables d'environnement: manipulées via python-decouple , il peut donc être stocké dans .env ou settings.ini fichier

Configuration via Env:

  • DEBUG : (par défaut: bool = true)
  • TESTING : (par défaut: bool = débogage)
  • APP_NAME : (default = flaskel)
  • APP_HOST : (par défaut = 127.0.0.1)
  • APP_PORT : (par défaut: int = 5000)
  • FLASK_APP : (par défaut = app: app)
  • SERVER_NAME : (default = app_host: app_port)
  • FLASK_ENV : (Default = Development)
  • LOCALE : (default = "en_en.utf8")
  • JWT_ALGORITHM : (default = "hs512")
  • JWT_ACCESS_TOKEN_EXPIRES : (par défaut: 1 jour)
  • JWT_REFRESH_TOKEN_EXPIRES : (par défaut: 14 jours)
  • TEMPLATES_AUTO_RELOAD : (par défaut: bool = debug)
  • EXPLAIN_TEMPLATE_LOADING : (par défaut: bool = false)
  • SEND_FILE_MAX_AGE_DEFAULT : (par défaut: 1 jour)
  • APIDOCS_ENABLED : (par défaut: bool = true)
  • CONF_PATH : (default = flaskel / scripts / squelette / res)
  • SQLALCHEMY_DATABASE_URI : (default = sqlite: ///db.sqlite)
  • REDIS_URL : (default = mongodb: // localhost)
  • REDIS_CONN_TIMEOUT : (par défaut: float = 0,05)
  • MONGO_URI : (par défaut = redis: //127.0.0.1: 6379)
  • MONGO_CONN_TIMEOUT_MS : (par défaut: int = 100)
  • MONGO_SERVER_SELECTION_TIMEOUT_MS : (par défaut: int = 100)
  • BASIC_AUTH_USERNAME : (default = admin)
  • BASIC_AUTH_PASSWORD : (default = admin)
  • ADMIN_EMAIL : (default = admin)
  • ADMIN_PASSWORD : (default = admin)
  • MAIL_DEBUG : (par défaut: bool = debug)
  • MAIL_SERVER : (Default = Sendria.local)
  • MAIL_PORT : (par défaut: int = 62000)
  • MAIL_USERNAME : (par défaut: "")
  • MAIL_PASSWORD : (par défaut: "")
  • MAIL_USE_SSL : (par défaut: bool = false)
  • MAIL_USE_TLS : (par défaut: bool = false)
  • MAIL_DEFAULT_SENDER : (default = [email protected])
  • MAIL_DEFAULT_RECEIVER : (default = [email protected])
  • MAIL_RECIPIENT : (par défaut: [email protected])
  • MAIL_TIMEOUT : (par défaut: int = 60)
  • PREFERRED_URL_SCHEME : (default = http if flask_env = développement else https)
  • LOG_BUILDER : (default = text)
  • LOG_APP_NAME : (default = app_name)
  • LOG_LOGGER_NAME : (default = flask_env)
  • LOG_REQ_SKIP_DUMP : (default = ne pas tester)
  • LOG_RESP_SKIP_DUMP : (default = ne pas tester)
  • LOG_RESP_HEADERS : (default = [])
  • LOG_REQ_HEADERS : (default = [])
  • CF_STRICT_ACCESS : (default = false)
  • VERSION_STORE_MAX : (par défaut = 6)
  • VERSION_CACHE_EXPIRE : (par défaut = 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 : (par défaut = 10)
  • USE_X_SENDFILE : (default = ne pas débogue)
  • ENABLE_ACCEL : (default = true)
  • WSGI_WERKZEUG_LINT_ENABLED : (default = test)
  • WSGI_WERKZEUG_PROFILER_ENABLED : (default = test)
  • WSGI_WERKZEUG_PROFILER_FILE : (default = "profiller.txt")
  • WSGI_WERKZEUG_PROFILER_RESTRICTION : * (par défaut: list = [0.1])
  • SQLALCHEMY_ECHO : (Default = Testing)
  • JSONRPC_BATCH_MAX_REQUEST : (par défaut = 10)
  • IPBAN_ENABLED : (par défaut = true)
  • IPBAN_KEY_PREFIX : (default = app_name)
  • IPBAN_KEY_SEP : (par défaut = /)
  • IPBAN_BACKEND : (par défaut = local)
  • IPBAN_BACKEND_OPTS : (default = {})
  • IPBAN_COUNT : (par défaut = 5)
  • IPBAN_SECONDS : (par défaut = 3600)
  • IPBAN_NET_WHITELIST : (par défaut = 127.0.0.0/8)
  • IPBAN_IP_WHITELIST : (par défaut = 127.0.0.1)
  • IPBAN_STATUS_CODE : (par défaut = 403)
  • IPBAN_CHECK_CODES : (par défaut = 404 405 501)
  • RATELIMIT_ENABLED : (par défaut = pas de débogage)
  • 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 : (par défaut = 1 heure)
  • CACHE_DISABLED : (default = false)

Configuration de l'application statique:

  • ERROR_PAGE : (default = "core / error.html")
  • DATABASE_URL : (default = sqlalchemy_database_uri)
  • SECRET_KEY_MIN_LENGTH : (par défaut: 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 = Aucun)
  • JWT_DEFAULT_TOKEN_TYPE : (default = "Bearer")
  • JWT_TOKEN_LOCATION : (par défaut = ["en-têtes", "query_string"])
  • HTTP_DUMP_BODY : (par défaut: [false, false])
  • ACCEL_BUFFERING : (default = true)
  • ACCEL_CHARSET : (default = "utf-8")
  • ACCEL_LIMIT_RATE : (default = "off")
  • RB_DEFAULT_ACCEPTABLE_MIMETYPES : (default = ["application / json", "application / xml"])
  • REQUEST_ID_HEADER : (default = "x-request-id")
  • CACHE_TYPE : (default = "flask_caching.backends.redis")
  • CACHE_OPTIONS : (dict)
  • CORS_EXPOSE_HEADERS : (liste)
  • RATELIMIT_STORAGE_OPTIONS : (dict)
  • SCHEDULER_JOBSTORES : (Dict)
  • SCHEDULER_EXECUTORS : (Dict)
  • SCHEDULER_JOB_DEFAULTS : (Dict)
  • LIMITER : (dict)
    • FAIL : (default = "1 / seconde")
    • FAST : (default = "30 / minute")
    • MEDIUM : (default = "20 / minute")
    • SLOW : (default = "10 / minute")
    • BYPASS_KEY : (default = "x-limiter-bypass")
    • BYPASS_VALUE : (default = "bypass-rate-lit")

Les configurations supplémentaires sont éventuellement chargées via des fichiers dans le dossier CONF_PATH :

  • APISPEC : (swagger.yaml)
  • SCHEMAS : (schémas.yaml)
  • SCHEDULER_JOBS : (scheduler.yaml)
  • LOGGING : (log.yaml) En cas de manque, flaskel.utils.logger:LOGGING est utilisée

Configuration spécifique pour les extensions internes:

  • flaskel.ext.crypto.argon.argon2

    • ARGON2_ENCODING : (default = utf-8)
    • ARGON2_TIME_COST : (par défaut = 3)
    • ARGON2_HASH_LEN : (par défaut = 32)
    • ARGON2_PARALLELISM : (par défaut = 4)
    • ARGON2_SALT_LEN : (par défaut = 16)
    • ARGON2_MEMORY_COST : (par défaut = 65536) 64 MIB
    • ARGON2_PROFILE : (par défaut = bas) autorisé bas |

  • flaskel.ext.healthcheck.health.healthcheck

    • HEALTHCHECK_ABOUT_LINK : (par défaut = aucun)
    • HEALTHCHECK_VIEW_NAME : (Default = HealthCheck)
    • HEALTHCHECK_PATH : (par défaut = / HealthCheck)
    • HEALTHCHECK_PARAM_KEY : (Default = chèques)
    • HEALTHCHECK_PARAM_SEP : (par défaut = +)
    • HEALTHCHECK_CONTENT_TYPE : (Default = Application / Health + JSON)

  • flaskel.ext.datetime.flaskdatehelper

    • DATE_HELPER_COUNTRY : (par défaut = it)
    • DATE_HELPER_PROV : (par défaut = aucun)
    • DATE_HELPER_STATE : (default = Aucun)
    • 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.faskipban

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

  • flaskel.ext.caching.caching

    • CACHE_TYPE : (default = "flask_caching.backends.redis")
    • CACHE_REDIS_URL : (default = redis_url)
    • CACHE_DEFAULT_TIMEOUT : (default = seconde.hour)
    • CACHE_KEY_PREFIX : (default = app_name)
    • CACHE_OPTIONS : (dict) transmis à l'instance du client redis

  • flaskel.ext.redis.flaskredis

    • REDIS_URL : (default = redis: // localhost: 6379/0)
    • REDIS_OPTS : (dict) transmis à l'instance du client redis

  • flaskel.ext.mongo.flaskmongodb

    • MONGO_URI : (default = MongoDB: // localhost)
    • MONGO_OPTS : (Dict) est passé à l'instance client MongoDB

  • flaskel.ext.useragent.Useragernt

    • USER_AGENT_AUTO_PARSE : (default = false)

  • flaskel.extra.stripe.paymentHandler (Stripe)

    • STRIPE_SECRET_KEY :
    • STRIPE_PUBLIC_KEY :
    • STRIPE_WEBHOOK_SECRET :
    • STRIPE_DEBUG : (par défaut = false)
    • STRIPE_DEFAULT_CURRENCY : (par défaut = EUR)
    • STRIPE_API_VERSION : (par défaut = 2020-08-27)

  • flaskel.extra.mobile_support.mobileversioncompatibilité (mobile_version)

    • VERSION_STORE_MAX : (par défaut = 6)
    • VERSION_CACHE_EXPIRE : (par défaut = 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_need)
    • VERSION_HEADER_KEY : (Default = X-Mobile-Version)
    • VERSION_UPGRADE_HEADER : (default = x-upgrade-need)
    • VERSION_AGENTS : (Default = (Android, iOS))
    • VERSION_SKIP_STATUSES : (default = (interdit, not_found, method_not_allowed, too_many_requests)))

  • flaskel.extra.notification.notificationHandler

    • FCM_API_KEY : obligatoire si utilisé

  • flaskel.extra.media.service.mediaservice

    • MEDIA : (Dict)
      • ALLOWED_EXTENSIONS : (par défaut: [png, jpg])
      • UPLOAD_FOLDER :
      • EXTERNAL_URL :
Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout