Cansin's Base SaaS (Flask)
Documentation:
Features
🧑💻 Developer Experience
☁️ Deployment
💳 Stripe Integrations
🔒 Authentication
📧 Transactional Emails with SMTP
🚨 Security
🎨 UI
🔔 Notifications
🌐 Bootstrap HTML templates
Development
Code Quality, Conventional Commits, and Releases
Developing in Dev Containers
Debugging
Testing Stripe Webhooks
Developing in a Virtual Environment
How to Build On Top of This App
Adding New Pages
Defining More Configuration Variables
Updating Dependencies
Continuous Integration and Continuous Deployment
Pre-Commit Hooks
Run Tests
Semantic Release
Build & Deploy
Build & Deploy Sphinx Docs
Deployment to Production
A Pitfall for Cloudflare Proxy
Auto Generated Documentation
app
Submodules
app.config
app.decorators
app.emails
app.forms
app.models
app.utilities
app.views
app.views_auth
app.views_private
Attributes
Functions
Package Contents
mail
db
bc
lm
csrf
create_app()
Additional Resources:
Contact the Developer
Cansin's Base SaaS (Flask)
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
account() (in module app.views_private)
add_credits() (app.models.Users method)
admin() (in module app.views_private)
app
module
app.config
module
app.decorators
module
app.emails
module
app.forms
module
app.models
module
app.utilities
module
app.utilities.error_handlers
module
app.utilities.helpers
module
app.utilities.object_storage
module
app.utilities.qr
module
app.utilities.stripe_event_handler
module
app.utilities.user_registration_actions
module
app.views
module
app.views_auth
module
app.views_private
module
APP_NAME (app.config.Config attribute)
APP_ROOT_URL (app.config.Config attribute)
appTimezone (in module app.config)
appTimezoneStr (in module app.config)
asyncr() (in module app.decorators)
auth_bp (in module app.views_auth)
avatar() (app.models.Users method)
avatar_uploaded (app.models.Users attribute)
B
BASEDIR (app.config.Config attribute)
bc (in module app)
billing() (in module app.views_private)
C
cancel_at (app.models.Users attribute)
code0 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code1 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code2 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code3 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code4 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code5 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
Config (class in app.config)
copy_file() (in module app.utilities.object_storage)
create_app() (in module app)
create_bucket() (in module app.utilities.object_storage)
credits (app.models.Users attribute)
csrf (in module app)
CSRF_ENABLED (app.config.Config attribute)
D
db (in module app)
deduct_credits() (app.models.Users method)
delete_file() (in module app.utilities.object_storage)
download_file() (in module app.utilities.object_storage)
E
email (app.forms.LoginForm attribute)
(app.forms.RegisterForm attribute)
(app.forms.ResetPassword attribute)
(app.models.Users attribute)
email_confirmation_by_code() (in module app.views_auth)
email_confirmation_code (app.models.Users attribute)
email_confirmed (app.models.Users attribute)
EmailConfirmationForm (class in app.forms)
error_page() (in module app.utilities.error_handlers)
F
favicon() (in module app.views)
firstName (app.forms.ProfileDetailsForm attribute)
(app.forms.RegisterForm attribute)
(app.models.Users attribute)
FLASK_DEBUG (app.config.Config attribute)
FLASK_RUN_CERT (app.config.Config attribute)
folder_quota() (app.models.Users method)
folder_size() (app.models.Users method)
(in module app.utilities.object_storage)
folder_usage_percentage() (app.models.Users method)
G
generate_download_link() (in module app.utilities.object_storage)
generate_n_digit_code() (in module app.utilities.helpers)
generate_remote_file() (in module app.utilities.object_storage)
generate_upload_link() (in module app.utilities.object_storage)
generate_upload_link_profile_picture() (in module app.utilities.object_storage)
generate_user_folder() (in module app.utilities.object_storage)
get_google_sso_config() (in module app.views_auth)
google_avatar_url (app.models.Users attribute)
GOOGLE_CLIENT_ID (app.config.Config attribute)
GOOGLE_CLIENT_SECRET (app.config.Config attribute)
H
handle_stripe_event() (in module app.utilities.stripe_event_handler)
I
id (app.models.Tiers attribute)
(app.models.Users attribute)
index() (in module app.views)
is_checkout_completed_event() (in module app.utilities.stripe_event_handler)
is_connected_google() (app.models.Users method)
is_subscription_event() (in module app.utilities.stripe_event_handler)
L
label (app.models.Tiers attribute)
last_confirmation_codes_sent (app.models.Users attribute)
last_login (app.models.Users attribute)
lastName (app.forms.ProfileDetailsForm attribute)
(app.forms.RegisterForm attribute)
(app.models.Users attribute)
limiter (in module app.views)
list_objects() (in module app.utilities.object_storage)
lm (in module app)
load_user() (in module app.views)
(in module app.views_auth)
login() (in module app.views_auth)
login_callback_google() (in module app.views_auth)
LoginForm (class in app.forms)
logout() (in module app.views_auth)
M
mail (in module app)
MAIL_DEBUG (app.config.Config attribute)
MAIL_FROM (app.config.Config attribute)
MAIL_PASSWORD (app.config.Config attribute)
MAIL_PORT (app.config.Config attribute)
MAIL_SERVER (app.config.Config attribute)
MAIL_USE_SSL (app.config.Config attribute)
MAIL_USE_TLS (app.config.Config attribute)
MAIL_USERNAME (app.config.Config attribute)
member_since (app.models.Users attribute)
module
app
app.config
app.decorators
app.emails
app.forms
app.models
app.utilities
app.utilities.error_handlers
app.utilities.helpers
app.utilities.object_storage
app.utilities.qr
app.utilities.stripe_event_handler
app.utilities.user_registration_actions
app.views
app.views_auth
app.views_private
N
name (app.models.Tiers attribute)
new_user_actions_for_email_confirmed() (in module app.utilities.user_registration_actions)
newsletter (app.forms.ProfileDetailsForm attribute)
(app.forms.RegisterForm attribute)
(app.models.Users attribute)
number_of_email_confirmation_codes_sent (app.models.Users attribute)
P
page_not_found() (in module app.views)
,
[1]
,
[2]
password (app.forms.LoginForm attribute)
(app.forms.RegisterForm attribute)
(app.forms.SetNewPassword attribute)
(app.models.Users attribute)
password_reset() (in module app.views_auth)
password_reset_requested() (in module app.views_auth)
prevent_public_access() (in module app.utilities.object_storage)
private_bp (in module app.views_private)
private_index() (in module app.views_private)
ProfileDetailsForm (class in app.forms)
public_bp (in module app.views)
Q
qrcode_img_src() (in module app.utilities.qr)
R
rate_limited() (in module app.views)
readable_file_size() (in module app.utilities.helpers)
register() (in module app.views_auth)
RegisterForm (class in app.forms)
ResetPassword (class in app.forms)
role (app.models.Users attribute)
S
s3 (in module app.config)
S3_BUCKET_NAME (app.config.Config attribute)
S3_ENDPOINT (app.config.Config attribute)
S3_KEY (app.config.Config attribute)
S3_SECRET (app.config.Config attribute)
save() (app.models.Users method)
SECRET_KEY (app.config.Config attribute)
send_async_email() (in module app.emails)
send_email_about_subscription_cancellation() (in module app.emails)
send_email_about_subscription_confirmation() (in module app.emails)
send_email_about_subscription_deletion() (in module app.emails)
send_email_to_reset_password() (in module app.emails)
send_email_with_code() (in module app.emails)
server_error() (in module app.views)
set_new_password() (in module app.views_auth)
SetNewPassword (class in app.forms)
SQLALCHEMY_DATABASE_URI (app.config.Config attribute)
SQLALCHEMY_ENGINE_OPTIONS (app.config.Config attribute)
SQLALCHEMY_TRACK_MODIFICATIONS (app.config.Config attribute)
STRIPE_CREDIT_UNIT_COST (app.config.Config attribute)
stripe_customer_id (app.models.Users attribute)
stripe_price_id (app.models.Tiers attribute)
STRIPE_PRODUCT_ID_FOR_CREDITS (app.config.Config attribute)
STRIPE_PUBLISHABLE_KEY (app.config.Config attribute)
STRIPE_SECRET_KEY (app.config.Config attribute)
STRIPE_WEBHOOK_SECRET (app.config.Config attribute)
T
tier (app.models.Users attribute)
tier_from_stripe_price_id() (in module app.utilities.stripe_event_handler)
tier_id (app.models.Users attribute)
Tiers (class in app.models)
TIMEZONE (app.config.Config attribute)
totp() (app.models.Users method)
totp_enabled (app.models.Users attribute)
totp_match() (app.models.Users method)
totp_reset_secret() (app.models.Users method)
totp_secret (app.models.Users attribute)
two_factor() (in module app.views_auth)
TwoFactorAuthenticationForm (class in app.forms)
U
unauthorized_callback() (in module app.views_auth)
upload_file() (in module app.utilities.object_storage)
user_folder_size() (in module app.utilities.object_storage)
user_from_stripe_customer_id() (in module app.utilities.stripe_event_handler)
users (app.models.Tiers attribute)
Users (class in app.models)
W
webhook() (in module app.views_private)