flaskel

Flaskel

Flaskel ist ein Skelett für alle Arten von Flask -Anwendung mit REST -APIs oder nicht.

Merkmale

• Anwendungsskelett:

    flaskel init --help

• Erweiterte App Factory, siehe: flaskel.builder.AppBuilder
• Unterstützung für das Testen mit flaskel.tester -Paket
• Sammlung von internen ext und externen ext gut integriert
• Sammlung von benutzerdefinierten Flaskansichten
• Unterstützen Sie mehrere WSGI -Server, aber Gunicorn wird gut unterstützt
• Führen Sie die App über CLI mit vielen Optionen aus
• Bessere Konfiguration über mehrere Quellen: Modul, YAML (oder JSON), Env -Variablen
• Bessere HTTP -Unterstützung für Client und Server, siehe: flaskel.http

Erweiterungen

Die Erweiterungen werden über AppBuilder registriert, siehe: flaskel.scripts.skeleton.ext

Dritte Erweiterungen:

• Flask-APScheduler
• Flask-Caching
• Flask-Cors
• Flask-httpauth
• Flask-Jwt
• Flask-Limiter
• Flask-Mail
• Flask-sqlalchemy
• Flask-Pymongo

Meine eigenen externen Erweiterungen:

• Flask-Cloudflareremote (Cloudflareremote)
• Flask-Errorhandler (fehler_handler)
• Flask-Logify (Logify)
• Flask-ResponseBuilder (response_builder)
• Flask-Templatesupport (template_support)

Interne Erweiterungen:

• 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) erweitert die Flask-E-Mail
• flaskel.ext.jobs.APJobs (Scheduler) erweitert Flask-apspleduler
• flaskel.ext.mongo.FlaskMongoDB (mongo) erweitert Flask-Pymongo
• flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), Standardprüfungen: Blicke, Mongo, Redis, Sqlalchemy, System, Dienste (HTTP -API)

Wrapper -Erweiterungen:

• flaskel.ext.caching.Cache Wraps Flask-Caching
• flaskel.ext.limit.RateLimit Wraps Flask-Limiter
• flaskel.ext.auth.DBTokenHandler , Flaskel.ext.auth.redistokenHandler Wraps Flask-JWT

Zusätzliche Erweiterungen:

• flaskel.extra.mobile_support.MobileVersionCompatibility (Mobile_version)
• flaskel.extra.stripe.PaymentHandler (Streifen)

Ansichten

Flaskel bietet nützliche Ansichten für die meisten häufigsten APIs oder einfachen Webcontroller:

• 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

Zusätzliche Ansichten:

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

Unterstützung von Sqlalchemy

Flaskel wird mit Hilfskomponenten aus SQLALCHEMY geliefert:

• Dump -Schema über CLI:

    flaskel schema --help

• Benutzerdefinierte Modellklasse fügt allen Modellen Funktionen hinzu

 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 ): ...

Datenstrukturen

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

Webargs -Unterstützung

 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 ()

JSON -Schema -Unterstützung

 class PayloadValidator :
    schemas = SCHEMAS
    validator = JSONSchema

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

Konfiguration

Es gibt viele Konfigurationsschlüssel, die von vielen Quellen bereitgestellt werden, der gleiche Schlüssel in verschiedenen Quellen wird überschrieben. Quellenprioritäten (niedrig bis hoch):

• Python -Modul: Alle Standards Flaskel.config
• Mapping (Diktat): Über CLI aus Yaml oder JSON -Datei
• Python -Modul: Über Umgebungsvariable APP_CONFIG_FILE
• Umgebungsvariablen: Überlegt über python-decouple , kann also in .EnV oder Einstellungen.ini-Datei gespeichert werden

Konfiguration über Env:

• DEBUG : (Standard: bool = true)
• TESTING : (Standard: bool = debug)
• APP_NAME : (default = flaskel)
• APP_HOST : (default = 127.0.0.1)
• APP_PORT : (Standard: int = 5000)
• FLASK_APP : (default = App: App)
• SERVER_NAME : (default = app_host: app_port)
• FLASK_ENV : (Standard = Entwicklung)
• LOCALE : (default = "en_en.utf8")
• JWT_ALGORITHM : (default = "hs512")
• JWT_ACCESS_TOKEN_EXPIRES : (Standard: 1 Tag)
• JWT_REFRESH_TOKEN_EXPIRES : (Standard: 14 Tag)
• TEMPLATES_AUTO_RELOAD : (Standard: bool = debug)
• EXPLAIN_TEMPLATE_LOADING : (Standard: bool = false)
• SEND_FILE_MAX_AGE_DEFAULT : (Standard: 1 Tag)
• APIDOCS_ENABLED : (Standard: bool = true)
• CONF_PATH : (default = Flaskel/Skripte/Skelett/res)
• SQLALCHEMY_DATABASE_URI : (default = sqlite: ///db.sqlite)
• REDIS_URL : (default = mongoDB: // localhost)
• REDIS_CONN_TIMEOUT : (Standard: float = 0,05)
• MONGO_URI : (default = redis: //127.0.0.1: 6379)
• MONGO_CONN_TIMEOUT_MS : (Standard: int = 100)
• MONGO_SERVER_SELECTION_TIMEOUT_MS : (Standard: int = 100)
• BASIC_AUTH_USERNAME : (default = admin)
• BASIC_AUTH_PASSWORD : (default = admin)
• ADMIN_EMAIL : (default = admin)
• ADMIN_PASSWORD : (default = admin)
• MAIL_DEBUG : (Standard: bool = debug)
• MAIL_SERVER : (default = sendria.local)
• MAIL_PORT : (Standard: int = 62000)
• MAIL_USERNAME : (Standard: "")
• MAIL_PASSWORD : (Standard: "")
• MAIL_USE_SSL : (Standard: bool = false)
• MAIL_USE_TLS : (Standard: bool = false)
• MAIL_DEFAULT_SENDER : (default = [email protected])
• MAIL_DEFAULT_RECEIVER : (default = [email protected])
• MAIL_RECIPIENT : (Standard: [email protected])
• MAIL_TIMEOUT : (Standard: int = 60)
• PREFERRED_URL_SCHEME : (default = http if Flask_env = Entwicklung sonst https)
• LOG_BUILDER : (default = text)
• LOG_APP_NAME : (default = app_name)
• LOG_LOGGER_NAME : (default = flask_env)
• LOG_REQ_SKIP_DUMP : (default = nicht testing)
• LOG_RESP_SKIP_DUMP : (default = nicht testing)
• LOG_RESP_HEADERS : (default = [])
• LOG_REQ_HEADERS : (default = [])
• CF_STRICT_ACCESS : (default = false)
• VERSION_STORE_MAX : (default = 6)
• VERSION_CACHE_EXPIRE : (default = 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 : (default = 10)
• USE_X_SENDFILE : (default = nicht debuggen)
• ENABLE_ACCEL : (default = true)
• WSGI_WERKZEUG_LINT_ENABLED : (default = testing)
• WSGI_WERKZEUG_PROFILER_ENABLED : (default = testing)
• WSGI_WERKZEUG_PROFILER_FILE : (default = "Profiler.txt")
• WSGI_WERKZEUG_PROFILER_RESTRICTION : *(Standard: list = [0.1])
• SQLALCHEMY_ECHO : (default = testing)
• JSONRPC_BATCH_MAX_REQUEST : (default = 10)
• IPBAN_ENABLED : (default = true)
• IPBAN_KEY_PREFIX : (default = app_name)
• IPBAN_KEY_SEP : (default = /)
• IPBAN_BACKEND : (default = local)
• IPBAN_BACKEND_OPTS : (default = {})
• IPBAN_COUNT : (default = 5)
• IPBAN_SECONDS : (default = 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 : (default = 404,405,501)
• RATELIMIT_ENABLED : (default = nicht debuggen)
• 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 : (default = 1 Stunde)
• CACHE_DISABLED : (default = false)

Statische Anwendungskonfiguration:

• ERROR_PAGE : (default = "core/error.html"))
• DATABASE_URL : (default = sqlalchemy_database_uri)
• SECRET_KEY_MIN_LENGTH : (Standard: 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 = ["Headers", "query_string"])
• HTTP_DUMP_BODY : (Standard: [Falsch, Falsch])
• 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 : (dikt)
• CORS_EXPOSE_HEADERS : (Liste)
• RATELIMIT_STORAGE_OPTIONS : (dict)
• SCHEDULER_JOBSTORES : (Diktat)
• SCHEDULER_EXECUTORS : (Diktat)
• SCHEDULER_JOB_DEFAULTS : (Diktat)
• LIMITER : (Diktat)
  • FAIL : (default = "1/Second")
  • FAST : (Standard = "30/Minute")
  • MEDIUM : (Standard = "20/Minute")
  • SLOW : (Standard = "10/Minute")
  • BYPASS_KEY : (default = "x-limiter-bypass"))
  • BYPASS_VALUE : (default = "Bypass-Rate-Limit"))

Zusätzliche Konfigurationen werden optional über Dateien in Ordner CONF_PATH geladen:

• APISPEC : (Swagger.yaml)
• SCHEMAS : (Schemas.yaml)
• SCHEDULER_JOBS : (SCHLAUER.YAML)
• LOGGING : (log.yaml) Wenn fehlt, standardisch flaskel.utils.logger:LOGGING wird verwendet

Konfigurationsspezifische für interne Erweiterungen:

• flaskel.ext.crypto.argon.argon2

  • ARGON2_ENCODING : (default = utf-8)
  • ARGON2_TIME_COST : (default = 3)
  • ARGON2_HASH_LEN : (default = 32)
  • ARGON2_PARALLELISM : (default = 4)
  • ARGON2_SALT_LEN : (default = 16)
  • ARGON2_MEMORY_COST : (default = 65536) 64 MIB
  • ARGON2_PROFILE : (default = niedrig) erlaubt niedrig | hoch

• Flaskel.ext.HealthCheck.Health.HealthCheck

  • HEALTHCHECK_ABOUT_LINK : (default = none)
  • HEALTHCHECK_VIEW_NAME : (default = HealthCheck)
  • HEALTHCHECK_PATH : (default = /heenhyCheck)
  • HEALTHCHECK_PARAM_KEY : (default = prüfungen)
  • HEALTHCHECK_PARAM_SEP : (default = +)
  • HEALTHCHECK_CONTENT_TYPE : (default = application/Health+JSON)

• flaskel.ext.datetime.flaskdatehelper

  • DATE_HELPER_COUNTRY : (default = it)
  • DATE_HELPER_PROV : (default = keine)
  • DATE_HELPER_STATE : (default = keine)
  • 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 : (default = true)
  • IPBAN_KEY_PREFIX : (default = app_name)
  • IPBAN_KEY_SEP : (default = /)
  • IPBAN_BACKEND : (default = local)
  • IPBAN_BACKEND_OPTS : (default = {})
  • IPBAN_COUNT : (default = 5)
  • IPBAN_SECONDS : (default = 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 : (default = 404,405,501)

• flaskel.ext.caching.caching

  • CACHE_TYPE : (default = "flask_caching.backends.redis"))
  • CACHE_REDIS_URL : (default = redis_url)
  • CACHE_DEFAULT_TIMEOUT : (default = Seconds.hour)
  • CACHE_KEY_PREFIX : (default = app_name)
  • CACHE_OPTIONS : (dikt) an redis client Instance übergeben

• flaskel.ext.redis.flaskredis

  • REDIS_URL : (default = redis: // localhost: 6379/0)
  • REDIS_OPTS : (dikt) an die Redis -Client -Instanz übergeben

• flaskel.ext.mongo.flaskMongodb

  • MONGO_URI : (default = mongoDB: // localhost)
  • MONGO_OPTS : (dikt) an die MongoDB -Client -Instanz übergeben

• flaskel.ext.useragent.useragent

  • USER_AGENT_AUTO_PARSE : (default = false)

• Flaskel.extra.stripe.PaymentHandler (Streifen)

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

• flaskel.extra.mobile_support.mobileversionCompatibilität (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-Bedarf)
  • VERSION_AGENTS : (default = (Android, iOS))
  • VERSION_SKIP_STATUSES : (default = (Forbidden, Not_Found, method_not_alowed, Too_Many_Requests)))

• flaskel.extra.notification.notificationHandler

  • FCM_API_KEY : obligatorisch, wenn verwendet

• Flaskel.extra.Media.Service.MediaService

  • MEDIA : (Diktat)
    • ALLOWED_EXTENSIONS : (Standard: [PNG, JPG])
    • UPLOAD_FOLDER :
    • EXTERNAL_URL :