Getting Started
Tutorial
Framework Reference
openviper.http.request
Request
UploadFile
openviper.http.response
Response
JSONResponse
HTMLResponse
PlainTextResponse
RedirectResponse
StreamingResponse
FileResponse
GZipResponse
openviper.http.views
View
action()
openviper.routing.router.Router
openviper.routing.router.Router.route()
openviper.routing.router.Router.get()
openviper.routing.router.Router.post()
openviper.routing.router.Router.put()
openviper.routing.router.Router.patch()
openviper.routing.router.Router.delete()
openviper.routing.router.Router.options()
openviper.routing.router.Router.any()
openviper.routing.router.Router.add()
openviper.routing.router.Router.include_router()
openviper.routing.router.Router.resolve()
openviper.routing.router.Router.url_for()
openviper.routing.router.Route
openviper.routing.router.include()
openviper.middleware.cors
CORSMiddleware
openviper.middleware.csrf
CSRFMiddleware
openviper.middleware.ratelimit
RateLimitMiddleware
openviper.middleware.ratelimit.rate_limit()
openviper.middleware.security
SecurityMiddleware
openviper.middleware.auth
openviper.middleware.base
BaseMiddleware
openviper.middleware.base.build_middleware_stack()
build_middleware_stack
ready()
INSTALLED_APPS
openviper.serializers.Serializer
openviper.serializers.Serializer.readonly_fields
openviper.serializers.Serializer.writeonly_fields
openviper.serializers.Serializer.PAGE_SIZE
openviper.serializers.Serializer.validate()
openviper.serializers.Serializer.validate_json_string()
openviper.serializers.Serializer.from_orm()
openviper.serializers.Serializer.from_orm_many()
openviper.serializers.Serializer.serialize()
openviper.serializers.Serializer.serialize_json()
openviper.serializers.Serializer.serialize_many()
openviper.serializers.Serializer.serialize_many_json()
openviper.serializers.Serializer.paginate()
openviper.serializers.PaginatedSerializer
openviper.serializers.ModelSerializer
openviper.serializers.ModelSerializer.create()
openviper.serializers.ModelSerializer.update()
openviper.serializers.ModelSerializer.save()
openviper.serializers.field_validator()
openviper.serializers.model_validator()
openviper.serializers.computed_field()
openviper.db.models
Model
AbstractModel
Manager
QuerySet
F
Q
Page
openviper.db.fields
openviper.db.connection
init_db()
close_db()
get_connection()
openviper.auth.jwt
create_access_token()
create_refresh_token()
decode_access_token()
decode_refresh_token()
decode_token_unverified()
openviper.auth.hashers
make_password()
check_password()
is_password_usable()
make_unusable_password()
openviper.auth.sessions
openviper.auth.session.manager.SessionManager
openviper.auth.decorators
login_required()
permission_required()
role_required()
superuser_required()
staff_required()
openviper.auth.models
AbstractUser
User
AnonymousUser
Permission
Role
RoleProfile
openviper.auth.authentications
TokenAuthentication
create_token()
revoke_token()
clear_token_auth_cache()
openviper.auth.middleware
AuthenticationMiddleware
openviper.auth.views.base_login
BaseLoginView
openviper.auth.views.jwt_login
JWTLoginView
openviper.auth.views.token_login
TokenLoginView
openviper.auth.views.session_login
SessionLoginView
openviper.auth.views.logout
openviper.auth.views.me
MeView
openviper.views.routes
jwt_routes
token_routes
session_routes
all_auth_routes
openviper.auth.views.oauth2
BaseOAuth2InitView
BaseOAuth2CallbackView
BaseOAuth2CallbackView.extract_user_info()
BaseOAuth2CallbackView.get_or_create_user()
BaseOAuth2CallbackView.get_token_request_data()
BaseOAuth2CallbackView.get_userinfo_headers()
BaseOAuth2CallbackView.complete_login()
GoogleOAuthInitView
GoogleOAuthCallbackView
google_oauth_routes
openviper.admin.options.ModelAdmin
openviper.admin.options.ModelAdmin.list_display
openviper.admin.options.ModelAdmin.list_display_links
openviper.admin.options.ModelAdmin.list_filter
openviper.admin.options.ModelAdmin.list_editable
openviper.admin.options.ModelAdmin.search_fields
openviper.admin.options.ModelAdmin.ordering
openviper.admin.options.ModelAdmin.list_per_page
openviper.admin.options.ModelAdmin.list_max_show_all
openviper.admin.options.ModelAdmin.date_hierarchy
openviper.admin.options.ModelAdmin.list_select_related
openviper.admin.options.ModelAdmin.fields
openviper.admin.options.ModelAdmin.exclude
openviper.admin.options.ModelAdmin.readonly_fields
openviper.admin.options.ModelAdmin.fieldsets
openviper.admin.options.ModelAdmin.form_fields
openviper.admin.options.ModelAdmin.list_display_styles
openviper.admin.options.ModelAdmin.sensitive_fields
openviper.admin.options.ModelAdmin.actions
openviper.admin.options.ModelAdmin.actions_on_top
openviper.admin.options.ModelAdmin.actions_on_bottom
openviper.admin.options.ModelAdmin.inlines
openviper.admin.options.ModelAdmin.child_tables
openviper.admin.options.ModelAdmin.save_on_top
openviper.admin.options.ModelAdmin.preserve_filters
openviper.admin.options.ModelAdmin.has_view_permission()
openviper.admin.options.ModelAdmin.has_add_permission()
openviper.admin.options.ModelAdmin.has_change_permission()
openviper.admin.options.ModelAdmin.has_delete_permission()
openviper.admin.options.ModelAdmin.save_model()
openviper.admin.options.ModelAdmin.delete_model()
openviper.admin.options.InlineModelAdmin
openviper.admin.options.InlineModelAdmin.model
openviper.admin.options.InlineModelAdmin.fk_name
openviper.admin.options.InlineModelAdmin.fields
openviper.admin.options.InlineModelAdmin.exclude
openviper.admin.options.InlineModelAdmin.readonly_fields
openviper.admin.options.InlineModelAdmin.extra
openviper.admin.options.InlineModelAdmin.max_num
openviper.admin.options.InlineModelAdmin.min_num
openviper.admin.options.InlineModelAdmin.can_delete
openviper.admin.options.TabularInline
openviper.admin.options.StackedInline
openviper.admin.options.ChildTable
openviper.admin.registry.AdminRegistry
openviper.admin.registry.AdminRegistry.register()
openviper.admin.registry.AdminRegistry.unregister()
openviper.admin.registry.AdminRegistry.is_registered()
openviper.admin.registry.AdminRegistry.get_admin()
openviper.admin.site.get_admin_site()
openviper.tasks.decorators
task()
openviper.tasks.scheduler
periodic()
openviper.tasks.core
Scheduler
openviper.tasks.schedule
IntervalSchedule
CronSchedule
openviper.tasks.broker
get_broker()
setup_broker()
openviper.tasks.results
get_task_result()
list_task_results()
get_task_result_sync()
send_email()
.txt
.html
.md
Path
(filename, content)
(filename, content, mimetype)
path
url
content
content_b64
AttachmentData
SMTPBackend
ConsoleBackend
openviper.core.email.message
EmailMessageData
build_message()
openviper.core.email.attachments
resolve_attachments()
openviper.core.email.backends
EmailSettings
get_backend()
openviper.core.email.queue
enqueue_email_job()
worker_available()
openviper.core.email.templates
render_template_content()
render_markdown()
openviper.openapi.schema
generate_openapi_schema()
reset_openapi_cache()
openviper.openapi.ui
get_swagger_html()
get_redoc_html()
openviper.openapi.router
openviper.template.environment.get_jinja2_env()
openviper.template.plugin_loader
openviper.template.plugin_loader.load()
openviper.storage.Storage
openviper.storage.Storage.save()
openviper.storage.Storage.delete()
openviper.storage.Storage.exists()
openviper.storage.Storage.url()
openviper.storage.Storage.size()
openviper.storage.FileSystemStorage
openviper.storage.default_storage
default_storage
openviper.staticfiles.StaticFilesMiddleware
openviper.staticfiles.static()
openviper.staticfiles.media()
openviper.staticfiles.collect_static()
OpenViperException
ImproperlyConfigured
SettingsValidationError
HTTPException
NotFound
MethodNotAllowed
PermissionDenied
Unauthorized
ValidationError
Conflict
TooManyRequests
AuthenticationFailed
TokenExpired
DoesNotExist
MultipleObjectsReturned
ModelNotFoundError
ModelCollisionError
Configuration & Operations
openviper.conf.Settings
openviper.conf.Settings.as_dict()
openviper.conf.settings._LazySettings
openviper.conf.settings._LazySettings.configure()
openviper.conf.settings.validate_settings()
openviper.conf.settings.generate_secret_key()
openviper.core.app_resolver.AppResolver
openviper.core.app_resolver.AppResolver.get_app_dirs()
openviper.core.context.current_user
openviper.core.context.ignore_permissions_ctx
openviper.utils.timezone
now()
get_current_timezone()
make_aware()
make_naive()
is_aware()
is_naive()
openviper.utils.datastructures
Headers
MutableHeaders
QueryParams
ImmutableMultiDict
openviper.utils.importlib
import_string()
reset_import_cache()
openviper.contrib.default.middleware
DefaultLandingMiddleware
openviper.contrib.default.landing
LANDING_HTML
openviper.ai.base
AIProvider
openviper.ai.registry
ProviderRegistry
openviper.ai.registry.provider_registry
openviper.ai.router
ModelRouter
openviper.ai.router.model_router
openviper.ai.extension
openviper.ai.devkit
SimpleProvider
normalize_response()
map_http_error()