Beranda>Sumber daya pembuatan situs web>Data situs web
Unduh

Flaskel

Flaskel adalah kerangka untuk semua jenis aplikasi Flask dengan API REST atau tidak.

Fitur

  • Skeleton Aplikasi: 
    flaskel init --help
  • Pabrik Aplikasi Lanjutan, lihat: flaskel.builder.AppBuilder
  • Dukungan untuk pengujian dengan paket flaskel.tester
  • Kumpulan ext internal dan eksternal ext terintegrasi dengan baik
  • Koleksi tampilan Flask Kustom
  • Mendukung beberapa server WSGI, tetapi Gunicorn didukung dengan baik
  • Jalankan aplikasi melalui CLI dengan banyak opsi
  • Konfigurasi yang lebih baik melalui beberapa sumber: modul, yaml (atau json), variabel env
  • Dukungan HTTP yang lebih baik untuk klien dan server, lihat: flaskel.http

Ekstensi

Ekstensi terdaftar melalui appBuilder, lihat: flaskel.scripts.skeleton.ext

Ekstensi pihak ketiga:

  • Flask-Apscheduler
  • CACHING FLASK
  • Flask-Cors
  • Flask-httpauth
  • Flask-jwt
  • Labu-limiter
  • Flask-Mail
  • Flask-sqlalchemy
  • Flask-Pymongo

Ekstensi eksternal saya sendiri:

  • Flask-cloudflareMote (cloudflareremote)
  • Flask-errorshandler (errors_handler)
  • Flask-Logify (Logify)
  • Flask-responsebuilder (response_builder)
  • Flask-templatesupport (template_support)

Ekstensi internal:

  • 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) memperluas flask-mail
  • flaskel.ext.jobs.APJobs (penjadwal) memperluas flask-apscheduler
  • flaskel.ext.mongo.FlaskMongoDB (mongo) memperluas flask-pymongo
  • flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), Pemeriksaan default: Lirik, Mongo, Redis, Sqlalchemy, Sistem, Layanan (HTTP API)

Ekstensi Pembungkus:

  • flaskel.ext.caching.Cache membungkus cache flask
  • flaskel.ext.limit.RateLimit membungkus limit labu
  • flaskel.ext.auth.DBTokenHandler , flaskel.ext.auth.redistokenHandler membungkus flask-jwt

Ekstensi Ekstra:

  • flaskel.extra.mobile_support.MobileVersionCompatibility (Mobile_Version)
  • flaskel.extra.stripe.PaymentHandler (stripe)

Tampilan

Flaskel hadir dengan tampilan yang berguna untuk API paling umum atau pengontrol web sederhana:

  • 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

Tampilan ekstra:

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

Dukungan Sqlalchemy

Flaskel dilengkapi dengan komponen pembantu dari Sqlalchemy:

  • Skema buang melalui CLI: 
    flaskel schema --help
  • Kelas model khusus daripada menambahkan fungsionalitas untuk semua model 
 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 ): ...

Struktur data 

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

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

Dukungan Skema JSON 

 class PayloadValidator :
    schemas = SCHEMAS
    validator = JSONSchema

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

Konfigurasi

Ada banyak kunci konfigurasi yang disediakan oleh banyak sumber, kunci yang sama dalam sumber yang berbeda ditimpa. Prioritas Sumber (Rendah ke Tinggi):

  • Modul Python: semua default flaskel.config
  • Pemetaan (Dikt): Via CLI dari file YAML atau JSON
  • Modul Python: via Variabel Lingkungan APP_CONFIG_FILE
  • Variabel Lingkungan: Ditangani melalui python-decouple , jadi dapat disimpan di .env atau pengaturan.

Konfigurasi melalui Env:

  • DEBUG : (default: bool = true)
  • TESTING : (default: bool = debug)
  • APP_NAME : (default = flaskel)
  • APP_HOST : (default = 127.0.0.1)
  • APP_PORT : (default: int = 5000)
  • FLASK_APP : (default = app: app)
  • SERVER_NAME : (default = app_host: app_port)
  • FLASK_ENV : (default = pengembangan)
  • LOCALE : (default = "en_en.utf8")
  • JWT_ALGORITHM : (default = "hs512")
  • JWT_ACCESS_TOKEN_EXPIRES : (default: 1 hari)
  • JWT_REFRESH_TOKEN_EXPIRES : (default: 14 hari)
  • TEMPLATES_AUTO_RELOAD : (default: bool = debug)
  • EXPLAIN_TEMPLATE_LOADING : (default: bool = false)
  • SEND_FILE_MAX_AGE_DEFAULT : (default: 1 hari)
  • APIDOCS_ENABLED : (default: bool = true)
  • CONF_PATH : (default = flaskel/skrip/kerangka/res)
  • SQLALCHEMY_DATABASE_URI : (default = sqlite: ///db.sqlite)
  • REDIS_URL : (default = mongodb: // localhost)
  • REDIS_CONN_TIMEOUT : (default: float = 0,05)
  • MONGO_URI : (default = redis: //127.0.0.1: 6379)
  • MONGO_CONN_TIMEOUT_MS : (default: int = 100)
  • MONGO_SERVER_SELECTION_TIMEOUT_MS : (default: int = 100)
  • BASIC_AUTH_USERNAME : (default = admin)
  • BASIC_AUTH_PASSWORD : (default = admin)
  • ADMIN_EMAIL : (default = admin)
  • ADMIN_PASSWORD : (default = admin)
  • MAIL_DEBUG : (default: bool = debug)
  • MAIL_SERVER : (default = sendria.local)
  • MAIL_PORT : (default: int = 62000)
  • MAIL_USERNAME : (default: "")
  • MAIL_PASSWORD : (default: "")
  • MAIL_USE_SSL : (default: bool = false)
  • MAIL_USE_TLS : (default: bool = false)
  • MAIL_DEFAULT_SENDER : (default = [email protected])
  • MAIL_DEFAULT_RECEIVER : (default = [email protected])
  • MAIL_RECIPIENT : (default: [email protected])
  • MAIL_TIMEOUT : (default: int = 60)
  • PREFERRED_URL_SCHEME : (default = http jika flask_env = pengembangan lain https)
  • LOG_BUILDER : (default = teks)
  • LOG_APP_NAME : (default = app_name)
  • LOG_LOGGER_NAME : (default = flask_env)
  • LOG_REQ_SKIP_DUMP : (default = tidak menguji)
  • LOG_RESP_SKIP_DUMP : (default = tidak menguji)
  • 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 = not debug)
  • ENABLE_ACCEL : (default = true)
  • WSGI_WERKZEUG_LINT_ENABLED : (default = pengujian)
  • WSGI_WERKZEUG_PROFILER_ENABLED : (default = pengujian)
  • WSGI_WERKZEUG_PROFILER_FILE : (default = "profiler.txt")
  • WSGI_WERKZEUG_PROFILER_RESTRICTION : *(default: list = [0.1])
  • SQLALCHEMY_ECHO : (default = pengujian)
  • JSONRPC_BATCH_MAX_REQUEST : (default = 10)
  • IPBAN_ENABLED : (default = true)
  • IPBAN_KEY_PREFIX : (default = app_name)
  • IPBAN_KEY_SEP : (default = /)
  • IPBAN_BACKEND : (default = lokal)
  • 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 = not debug)
  • 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 jam)
  • CACHE_DISABLED : (default = false)

Konfigurasi Aplikasi Statis:

  • ERROR_PAGE : (default = "core/error.html")
  • DATABASE_URL : (default = sqlalchemy_database_uri)
  • SECRET_KEY_MIN_LENGTH : (default: 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 = tidak ada)
  • JWT_DEFAULT_TOKEN_TYPE : (default = "bearer")
  • JWT_TOKEN_LOCATION : (default = ["header", "query_string"])
  • HTTP_DUMP_BODY : (default: [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 : (daftar)
  • RATELIMIT_STORAGE_OPTIONS : (dikt)
  • SCHEDULER_JOBSTORES : (DICT)
  • SCHEDULER_EXECUTORS : (dikt)
  • SCHEDULER_JOB_DEFAULTS : (DICT)
  • LIMITER : (dikt)
    • FAIL : (default = "1/detik")
    • FAST : (default = "30/menit")
    • MEDIUM : (default = "20/menit")
    • SLOW : (default = "10/menit")
    • BYPASS_KEY : (default = "x-limiter-bypass")
    • BYPASS_VALUE : (default = "bypass-rate-limit")

Konfigurasi tambahan secara opsional dimuat melalui file di folder CONF_PATH :

  • APISPEC : (Swagger.yaml)
  • SCHEMAS : (schemas.yaml)
  • SCHEDULER_JOBS : (SCRECTERER.YAML)
  • LOGGING : (log.yaml) jika hilang, flaskel.utils.logger:LOGGING digunakan

Konfigurasi Spesifik untuk Ekstensi Internal:

  • 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 = rendah) diizinkan rendah | tinggi

  • flaskel.ext.healthcheck.health.healthcheck

    • HEALTHCHECK_ABOUT_LINK : (default = tidak ada)
    • HEALTHCHECK_VIEW_NAME : (default = healthcheck)
    • HEALTHCHECK_PATH : (default = /healthcheck)
    • HEALTHCHECK_PARAM_KEY : (default = checks)
    • HEALTHCHECK_PARAM_SEP : (default = +)
    • HEALTHCHECK_CONTENT_TYPE : (default = aplikasi/kesehatan+json)

  • flaskel.ext.dateTime.flaskdateHelper

    • DATE_HELPER_COUNTRY : (default = it)
    • DATE_HELPER_PROV : (default = tidak ada)
    • DATE_HELPER_STATE : (default = tidak ada)
    • 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 = lokal)
    • 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 = detiks.hour)
    • CACHE_KEY_PREFIX : (default = app_name)
    • CACHE_OPTIONS : (Dict) diteruskan ke instance klien Redis

  • flaskel.ext.redis.flaskredis

    • REDIS_URL : (default = redis: // localhost: 6379/0)
    • REDIS_OPTS : (dikt) diteruskan ke instance klien redis

  • flaskel.ext.mongo.flaskmongodb

    • MONGO_URI : (default = mongoDb: // localhost)
    • MONGO_OPTS : (dict) diteruskan ke contoh klien 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 : (default = false)
    • STRIPE_DEFAULT_CURRENCY : (default = EUR)
    • STRIPE_API_VERSION : (default = 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-versi)
    • VERSION_STORE_KEY : (default = x_upgrade_needed)
    • VERSION_HEADER_KEY : (default = x-mobile-versi)
    • VERSION_UPGRADE_HEADER : (default = x-upgrade yang dibutuhkan)
    • VERSION_AGENTS : (default = (android, iOS))
    • VERSION_SKIP_STATUSES : (default = (Forbidden, not_found, method_not_allowed, too_many_requests)))

  • flaskel.extra.notification.NotificationHandler

    • FCM_API_KEY : wajib jika digunakan

  • flaskel.extra.media.service.mediaservice

    • MEDIA : (Dikt)
      • ALLOWED_EXTENSIONS : (default: [png, jpg])
      • UPLOAD_FOLDER :
      • EXTERNAL_URL :
Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua