Загрузка flaskel - скачать исходный код flaskel

flaskel

Данные веб-сайта

1.0.0

Скачать

Фласкель

Flaskel - это скелет для всех типов применения колбы с API REST или нет.

Функции

Приложение скелет:

    flaskel init --help

Advanced App Factory, см.: flaskel.builder.AppBuilder
Поддержка тестирования с пакетом flaskel.tester
Сбор внутренней ext и внешний Ext хорошо интегрирован
Коллекция видов на нестандартные колбы
Поддержите несколько серверов WSGI, но одушечный обшир хорошо поддерживается
Запустите приложение через CLI со многими вариантами
Лучшая конфигурация через несколько источников: модуль, YAML (или JSON), переменные ENV
Лучше http -поддержка для клиента и сервера, см.: flaskel.http

Расширения

Расширения зарегистрированы через AppBuilder, см.: flaskel.scripts.skeleton.ext

Расширения третьих сторон:

Flask-apscheduler
Колбс-Кэширование
Колбс-Корс
Flask-Httpauth
Flask-jwt
Флага-лимитр
Флека-mail
Flask-Sqlalchemy
Флас-пимонго

Мои собственные внешние расширения:

Flask-CloudflarereMote (CloudFlarereMote)
Flask-errorshandler (errors_handler)
Flask-logify (logify)
Flask-responseBuilder (response_builder)
Flask-TemplatesUpport (Template_Support)

Внутренние расширения:

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) Extends Flask-mail
flaskel.ext.jobs.APJobs (планировщик) расширяет Flask-apscheduler
flaskel.ext.mongo.FlaskMongoDB (mongo) Extens Flask-Pymongo
flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), Проверки по умолчанию: взгляды, Mongo, Redis, Sqlalchemy, System, Services (HTTP API)

Расширения обертки:

flaskel.ext.caching.Cache завершает колб
flaskel.ext.limit.RateLimit wraps flask-limiter
flaskel.ext.auth.DBTokenHandler , flaskel.ext.auth.redistokenhandler wraps flask-jwt

Дополнительные расширения:

flaskel.extra.mobile_support.MobileVersionCompatibility (mobile_version)
flaskel.extra.stripe.PaymentHandler (полоса)

Виды

Flaskel поставляется с полезными представлениями для большинства распространенных API или простых веб -контроллеров:

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

Дополнительные просмотры:

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

Поддержка SQLALCHEMY

Flaskel поставляется с вспомогательными компонентами от Sqlalchemy:

схема сброса через CLI:

    flaskel schema --help

Пользовательский класс модели, чем добавляет функциональности ко всем моделям

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

Структуры данных

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

Поддержка 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 ()

Поддержка схемы JSON

 class PayloadValidator :
    schemas = SCHEMAS
    validator = JSONSchema

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

Конфигурация

Существует много клавиш конфигурации, предоставляемые многими источниками, один и тот же ключ в разных источниках переопределена. Приоритеты источника (от низкого до высокого):

модуль Python: все по умолчанию flaskel.config
Картирование (DICT): через CLI из файла YAML или JSON
модуль Python: через переменную среды APP_CONFIG_FILE
Переменные среды: обрабатывается через python-decouple , поэтому можно хранить в файле .env или settings.ini

Конфигурация через Env:

DEBUG : (по умолчанию: bool = true)
TESTING : (по умолчанию: bool = отладка)
APP_NAME : (по умолчанию = Flaskel)
APP_HOST : (по умолчанию = 127.0.0.1)
APP_PORT : (по умолчанию: int = 5000)
FLASK_APP : (по умолчанию = приложение: приложение)
SERVER_NAME : (default = app_host: app_port)
FLASK_ENV : (по умолчанию = разработка)
LOCALE : (по умолчанию = "en_en.utf8")
JWT_ALGORITHM : (default = "hs512")
JWT_ACCESS_TOKEN_EXPIRES : (по умолчанию: 1 день)
JWT_REFRESH_TOKEN_EXPIRES : (по умолчанию: 14 дней)
TEMPLATES_AUTO_RELOAD : (по умолчанию: bool = debug)
EXPLAIN_TEMPLATE_LOADING : (по умолчанию: bool = false)
SEND_FILE_MAX_AGE_DEFAULT : (по умолчанию: 1 день)
APIDOCS_ENABLED : (по умолчанию: bool = true)
CONF_PATH : (по умолчанию = Flaskel/Scripts/Skeleton/Res)
SQLALCHEMY_DATABASE_URI : (default = sqlite: //db.sqlite)
REDIS_URL : (по умолчанию = mongodb: // localhost)
REDIS_CONN_TIMEOUT : (по умолчанию: float = 0,05)
MONGO_URI : (по умолчанию = Redis: //127.0.0.1: 6379)
MONGO_CONN_TIMEOUT_MS : (по умолчанию: int = 100)
MONGO_SERVER_SELECTION_TIMEOUT_MS : (по умолчанию: int = 100)
BASIC_AUTH_USERNAME : (по умолчанию = администратор)
BASIC_AUTH_PASSWORD : (default = admin)
ADMIN_EMAIL : (по умолчанию = администратор)
ADMIN_PASSWORD : (по умолчанию = администратор)
MAIL_DEBUG : (по умолчанию: bool = debug)
MAIL_SERVER : (default = sendria.local)
MAIL_PORT : (по умолчанию: int = 62000)
MAIL_USERNAME : (по умолчанию: "")
MAIL_PASSWORD : (по умолчанию: "")
MAIL_USE_SSL : (по умолчанию: bool = false)
MAIL_USE_TLS : (по умолчанию: bool = false)
MAIL_DEFAULT_SENDER : (default = [email protected])
MAIL_DEFAULT_RECEIVER : (default = [email protected])
MAIL_RECIPIENT : (по умолчанию: [email protected])
MAIL_TIMEOUT : (по умолчанию: int = 60)
PREFERRED_URL_SCHEME : (по умолчанию = http, если flask_env = development else https)
LOG_BUILDER : (по умолчанию = текст)
LOG_APP_NAME : (default = app_name)
LOG_LOGGER_NAME : (по умолчанию = flask_env)
LOG_REQ_SKIP_DUMP : (по умолчанию = не тестирование)
LOG_RESP_SKIP_DUMP : (по умолчанию = не тестирование)
LOG_RESP_HEADERS : (default = [])
LOG_REQ_HEADERS : (default = [])
CF_STRICT_ACCESS : (по умолчанию = false)
VERSION_STORE_MAX : (по умолчанию = 6)
VERSION_CACHE_EXPIRE : (по умолчанию = 60)
HTTP_PROTECT_BODY : (по умолчанию = false)
HTTP_DUMP_REQ_BODY : (по умолчанию = false)
HTTP_DUMP_RESP_BODY : (по умолчанию = false)
HTTP_SSL_VERIFY : (default = true)
HTTP_TIMEOUT : (по умолчанию = 10)
USE_X_SENDFILE : (по умолчанию = не отладка)
ENABLE_ACCEL : (по умолчанию = true)
WSGI_WERKZEUG_LINT_ENABLED : (по умолчанию = тестирование)
WSGI_WERKZEUG_PROFILER_ENABLED : (default = testing)
WSGI_WERKZEUG_PROFILER_FILE : (default = "profiler.txt")
WSGI_WERKZEUG_PROFILER_RESTRICTION : *(по умолчанию: list = [0.1])
SQLALCHEMY_ECHO : (по умолчанию = тестирование)
JSONRPC_BATCH_MAX_REQUEST : (по умолчанию = 10)
IPBAN_ENABLED : (default = true)
IPBAN_KEY_PREFIX : (default = app_name)
IPBAN_KEY_SEP : (по умолчанию = /)
IPBAN_BACKEND : (по умолчанию = локальный)
IPBAN_BACKEND_OPTS : (default = {})
IPBAN_COUNT : (по умолчанию = 5)
IPBAN_SECONDS : (по умолчанию = 3600)
IPBAN_NET_WHITELIST : (по умолчанию = 127.0.0.0/8)
IPBAN_IP_WHITELIST : (по умолчанию = 127.0.0.1)
IPBAN_STATUS_CODE : (по умолчанию = 403)
IPBAN_CHECK_CODES : (по умолчанию = 404 405 501)
RATELIMIT_ENABLED : (по умолчанию = не отладка)
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 : (по умолчанию = true)
SCHEDULER_API_ENABLED : (по умолчанию = false)
CACHE_KEY_PREFIX : (по умолчанию = app_name)
CACHE_REDIS_URL : (по умолчанию = Redis_url)
CACHE_DEFAULT_TIMEOUT : (по умолчанию = 1 час)
CACHE_DISABLED : (default = false)

Статическая конфигурация приложения:

ERROR_PAGE : (default = "core/error.html")
DATABASE_URL : (по умолчанию = SQLalchemy_Database_uri)
SECRET_KEY_MIN_LENGTH : (по умолчанию: int = 256)
PRETTY_DATE : (defall = " %d %b %y %i: %m %p")
DATE_ISO_FORMAT : (default = "%y-%m-%dt%h:%m:%s")
JWT_DEFAULT_SCOPE : (по умолчанию = нет)
JWT_DEFAULT_TOKEN_TYPE : (default = "searer")
JWT_TOKEN_LOCATION : (по умолчанию = ["заголовки", "Query_string"])
HTTP_DUMP_BODY : (по умолчанию: [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 : (список)
RATELIMIT_STORAGE_OPTIONS : (dict)
SCHEDULER_JOBSTORES : (dict)
SCHEDULER_EXECUTORS : (dict)
SCHEDULER_JOB_DEFAULTS : (dict)
LIMITER : (дикт)
- FAIL : (default = "1/Second")
- FAST : (по умолчанию = "30/минута")
- MEDIUM : (по умолчанию = "20/минута")
- SLOW : (по умолчанию = "10/минута")
- BYPASS_KEY : (default = "x-limiter-bypass")
- BYPASS_VALUE : (default = "uppass-rate-limit")

Дополнительные конфигурации загружаются с помощью файлов в папке CONF_PATH :

APISPEC : (Swagger.yaml)
SCHEMAS : (Schemas.yaml)
SCHEDULER_JOBS : (pradeler.yaml)
LOGGING : (log.yaml) Если отсутствует, по умолчанию flaskel.utils.logger:LOGGING

Конфигурация, специфичная для внутренних расширений:

flaskel.ext.crypto.argon.argon2
- ARGON2_ENCODING : (по умолчанию = UTF-8)
- ARGON2_TIME_COST : (по умолчанию = 3)
- ARGON2_HASH_LEN : (по умолчанию = 32)
- ARGON2_PARALLELISM : (по умолчанию = 4)
- ARGON2_SALT_LEN : (по умолчанию = 16)
- ARGON2_MEMORY_COST : (по умолчанию = 65536) 64 Mib
- ARGON2_PROFILE : (default = low) разрешен низким |
flaskel.ext.healthcheck.health.healthcheck
- HEALTHCHECK_ABOUT_LINK : (по умолчанию = нет)
- HEALTHCHECK_VIEW_NAME : (по умолчанию = HealthCheck)
- HEALTHCHECK_PATH : (по умолчанию = /healthCheck)
- HEALTHCHECK_PARAM_KEY : (по умолчанию = проверки)
- HEALTHCHECK_PARAM_SEP : (по умолчанию = +)
- HEALTHCHECK_CONTENT_TYPE : (default = Application/Health+json)
flaskel.ext.datetime.flaskdateHelper
- DATE_HELPER_COUNTRY : (default = it)
- DATE_HELPER_PROV : (по умолчанию = нет)
- DATE_HELPER_STATE : (по умолчанию = нет)
- 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 : (по умолчанию = false)
- SCHEDULER_PATCH_MULTITHREAD : (default = true)
- SCHEDULER_LOCK_FILE : (по умолчанию = .scheduler.lock)
flaskel.ext.ipban.flaskipban
- IPBAN_ENABLED : (default = true)
- IPBAN_KEY_PREFIX : (default = app_name)
- IPBAN_KEY_SEP : (по умолчанию = /)
- IPBAN_BACKEND : (по умолчанию = локальный)
- IPBAN_BACKEND_OPTS : (default = {})
- IPBAN_COUNT : (по умолчанию = 5)
- IPBAN_SECONDS : (по умолчанию = 3600)
- IPBAN_NET_WHITELIST : (по умолчанию = 127.0.0.0/8)
- IPBAN_IP_WHITELIST : (по умолчанию = 127.0.0.1)
- IPBAN_STATUS_CODE : (по умолчанию = 403)
- IPBAN_CHECK_CODES : (по умолчанию = 404 405 501)
flaskel.ext.caching.caching
- CACHE_TYPE : (default = "flask_caching.backends.redis")
- CACHE_REDIS_URL : (по умолчанию = Redis_url)
- CACHE_DEFAULT_TIMEOUT : (default = seconds.hour)
- CACHE_KEY_PREFIX : (по умолчанию = app_name)
- CACHE_OPTIONS : (dict) передается в экземпляр клиента Redis
flaskel.ext.redis.flaskredis
- REDIS_URL : (по умолчанию = redis: // localhost: 6379/0)
- REDIS_OPTS : (dict) передано в экземпляр клиента Redis
flaskel.ext.mongo.flaskmongodb
- MONGO_URI : (по умолчанию = mongodb: // localhost)
- MONGO_OPTS : (dict) передается в экземпляр клиента MongoDB
flaskel.ext.useragent.useragent
- USER_AGENT_AUTO_PARSE : (по умолчанию = false)
flaskel.extra.stripe.paymenthandler (полоса)
- STRIPE_SECRET_KEY :
- STRIPE_PUBLIC_KEY :
- STRIPE_WEBHOOK_SECRET :
- STRIPE_DEBUG : (по умолчанию = false)
- STRIPE_DEFAULT_CURRENCY : (default = eur)
- STRIPE_API_VERSION : (по умолчанию = 2020-08-27)
flaskel.extra.mobile_support.mobileversioncompatibility (mobile_version)
- VERSION_STORE_MAX : (по умолчанию = 6)
- VERSION_CACHE_EXPIRE : (по умолчанию = 3600)
- VERSION_CHECK_ENABLED : (default = true)
- VERSION_AGENT_HEADER : (по умолчанию = x-agent)
- VERSION_API_HEADER : (по умолчанию = x-api-version)
- VERSION_STORE_KEY : (default = x_upgrade_needed)
- VERSION_HEADER_KEY : (по умолчанию = x-mobile-version)
- VERSION_UPGRADE_HEADER : (default = x-upgrade-needed)
- VERSION_AGENTS : (по умолчанию = (Android, iOS))
- VERSION_SKIP_STATUSES : (default = (запрещено, not_found, method_not_allowed, to_many_requests)))
flaskel.extra.notification.notificationHandler
- FCM_API_KEY : обязательно при использовании
flaskel.extra.media.service.mediaservice
- MEDIA : (DICT)
  - ALLOWED_EXTENSIONS : (по умолчанию: [PNG, JPG])
  - UPLOAD_FOLDER :
  - EXTERNAL_URL :