From 3a708b304319afe84ebf3d40ecebabe6acc339f3 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Mon, 7 Jun 2021 13:59:08 +0530 Subject: started work on automatic documentation --- docs/_build/html/autoapi/app/apis/index.html | 136 +++++++++++ docs/_build/html/autoapi/app/config/index.html | 179 ++++++++++++++ docs/_build/html/autoapi/app/config_dev/index.html | 179 ++++++++++++++ .../html/autoapi/app/forms/app_forms/index.html | 209 +++++++++++++++++ docs/_build/html/autoapi/app/forms/index.html | 114 +++++++++ docs/_build/html/autoapi/app/index.html | 259 +++++++++++++++++++++ docs/_build/html/autoapi/app/misc_func/index.html | 144 ++++++++++++ docs/_build/html/autoapi/app/models/index.html | 216 +++++++++++++++++ .../html/autoapi/app/tests/conftest/index.html | 139 +++++++++++ docs/_build/html/autoapi/app/tests/index.html | 121 ++++++++++ .../html/autoapi/app/tests/test_admin/index.html | 132 +++++++++++ .../html/autoapi/app/tests/test_cli/index.html | 131 +++++++++++ .../html/autoapi/app/tests/test_fastapi/index.html | 160 +++++++++++++ .../html/autoapi/app/tests/test_forms/index.html | 140 +++++++++++ .../html/autoapi/app/tests/test_models/index.html | 130 +++++++++++ .../html/autoapi/app/tests/test_views/index.html | 169 ++++++++++++++ .../_build/html/autoapi/app/views/admin/index.html | 159 +++++++++++++ docs/_build/html/autoapi/app/views/auth/index.html | 203 ++++++++++++++++ .../html/autoapi/app/views/error_pages/index.html | 157 +++++++++++++ docs/_build/html/autoapi/app/views/index.html | 117 ++++++++++ docs/_build/html/autoapi/app/views/main/index.html | 141 +++++++++++ 21 files changed, 3335 insertions(+) create mode 100644 docs/_build/html/autoapi/app/apis/index.html create mode 100644 docs/_build/html/autoapi/app/config/index.html create mode 100644 docs/_build/html/autoapi/app/config_dev/index.html create mode 100644 docs/_build/html/autoapi/app/forms/app_forms/index.html create mode 100644 docs/_build/html/autoapi/app/forms/index.html create mode 100644 docs/_build/html/autoapi/app/index.html create mode 100644 docs/_build/html/autoapi/app/misc_func/index.html create mode 100644 docs/_build/html/autoapi/app/models/index.html create mode 100644 docs/_build/html/autoapi/app/tests/conftest/index.html create mode 100644 docs/_build/html/autoapi/app/tests/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_admin/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_cli/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_fastapi/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_forms/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_models/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_views/index.html create mode 100644 docs/_build/html/autoapi/app/views/admin/index.html create mode 100644 docs/_build/html/autoapi/app/views/auth/index.html create mode 100644 docs/_build/html/autoapi/app/views/error_pages/index.html create mode 100644 docs/_build/html/autoapi/app/views/index.html create mode 100644 docs/_build/html/autoapi/app/views/main/index.html (limited to 'docs/_build/html/autoapi/app') diff --git a/docs/_build/html/autoapi/app/apis/index.html b/docs/_build/html/autoapi/app/apis/index.html new file mode 100644 index 0000000..8bef03d --- /dev/null +++ b/docs/_build/html/autoapi/app/apis/index.html @@ -0,0 +1,136 @@ + + + + + + + + + app.apis — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.apis

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

API_Version()

API_User_Details(email: str)

+
+
+async app.apis.API_Version()
+
+ +
+
+async app.apis.API_User_Details(email: str)
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/config/index.html b/docs/_build/html/autoapi/app/config/index.html new file mode 100644 index 0000000..041002c --- /dev/null +++ b/docs/_build/html/autoapi/app/config/index.html @@ -0,0 +1,179 @@ + + + + + + + + + app.config — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.config

+
+

Module Contents

+
+
+app.config.SQLALCHEMY_DATABASE_URI = sqlite:////tmp/test.db
+
+ +
+
+app.config.SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+ +
+
+app.config.SECRET_KEY = tchtchtch
+
+ +
+
+app.config.ADMIN_EMAIL = admin@example.com
+
+ +
+
+app.config.ADMIN_PASSWORD = iamgroot
+
+ +
+
+app.config.GOOGLE_CLIENT_ID
+
+ +
+
+app.config.GOOGLE_CLIENT_SECRET
+
+ +
+
+app.config.MAIL_BACKEND = smtp
+
+ +
+
+app.config.MAIL_SERVER
+
+ +
+
+app.config.MAIL_PORT
+
+ +
+
+app.config.MAIL_USERNAME
+
+ +
+
+app.config.MAIL_PASSWORD
+
+ +
+
+app.config.MAIL_FROM
+
+ +
+
+app.config.MAIL_USE_TLS
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/config_dev/index.html b/docs/_build/html/autoapi/app/config_dev/index.html new file mode 100644 index 0000000..c2b1049 --- /dev/null +++ b/docs/_build/html/autoapi/app/config_dev/index.html @@ -0,0 +1,179 @@ + + + + + + + + + app.config_dev — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.config_dev

+
+

Module Contents

+
+
+app.config_dev.SQLALCHEMY_DATABASE_URI = sqlite:////tmp/test.db
+
+ +
+
+app.config_dev.SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+ +
+
+app.config_dev.SECRET_KEY = tchtchtch
+
+ +
+
+app.config_dev.ADMIN_EMAIL = admin@example.com
+
+ +
+
+app.config_dev.ADMIN_PASSWORD = iamgroot
+
+ +
+
+app.config_dev.GOOGLE_CLIENT_ID
+
+ +
+
+app.config_dev.GOOGLE_CLIENT_SECRET
+
+ +
+
+app.config_dev.MAIL_BACKEND = smtp
+
+ +
+
+app.config_dev.MAIL_SERVER
+
+ +
+
+app.config_dev.MAIL_PORT
+
+ +
+
+app.config_dev.MAIL_USERNAME
+
+ +
+
+app.config_dev.MAIL_PASSWORD
+
+ +
+
+app.config_dev.MAIL_FROM
+
+ +
+
+app.config_dev.MAIL_USE_TLS
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/forms/app_forms/index.html b/docs/_build/html/autoapi/app/forms/app_forms/index.html new file mode 100644 index 0000000..cc60e1e --- /dev/null +++ b/docs/_build/html/autoapi/app/forms/app_forms/index.html @@ -0,0 +1,209 @@ + + + + + + + + + app.forms.app_forms — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.forms.app_forms

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + + + + +

MyForm

Flask-specific subclass of WTForms Form.

UserSignUp

Flask-specific subclass of WTForms Form.

UserLogIn

Flask-specific subclass of WTForms Form.

+
+
+class app.forms.app_forms.MyForm(formdata=_Auto, **kwargs)
+

Bases: flask_wtf.FlaskForm

+

Flask-specific subclass of WTForms Form.

+

If formdata is not specified, this will use flask.request.form +and flask.request.files. Explicitly pass formdata=None to +prevent this.

+
+
+name
+
+ +
+
+email
+
+ +
+
+subject
+
+ +
+
+body
+
+ +
+ +
+
+class app.forms.app_forms.UserSignUp(formdata=_Auto, **kwargs)
+

Bases: flask_wtf.FlaskForm

+

Flask-specific subclass of WTForms Form.

+

If formdata is not specified, this will use flask.request.form +and flask.request.files. Explicitly pass formdata=None to +prevent this.

+
+
+first_name
+
+ +
+
+last_name
+
+ +
+
+email
+
+ +
+
+password
+
+ +
+ +
+
+class app.forms.app_forms.UserLogIn(formdata=_Auto, **kwargs)
+

Bases: flask_wtf.FlaskForm

+

Flask-specific subclass of WTForms Form.

+

If formdata is not specified, this will use flask.request.form +and flask.request.files. Explicitly pass formdata=None to +prevent this.

+
+
+email
+
+ +
+
+password
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/forms/index.html b/docs/_build/html/autoapi/app/forms/index.html new file mode 100644 index 0000000..bae3ec2 --- /dev/null +++ b/docs/_build/html/autoapi/app/forms/index.html @@ -0,0 +1,114 @@ + + + + + + + + + app.forms — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.forms

+
+

Submodules

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/index.html b/docs/_build/html/autoapi/app/index.html new file mode 100644 index 0000000..79f1e8c --- /dev/null +++ b/docs/_build/html/autoapi/app/index.html @@ -0,0 +1,259 @@ + + + + + + + + + app — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+ +
+
+
+

Package Contents

+
+

Functions

+ ++++ + + + + + + + + + + + + + + +

create_database()

delete_database()

make_superuser_database()

load_user(email)

+
+
+

Attributes

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + +

app

bcrypt

db

login_manager

oauth

mail

database_cli

+
+
+app.app
+
+ +
+
+app.bcrypt
+
+ +
+
+app.db
+
+ +
+
+app.login_manager
+
+ +
+
+app.oauth
+
+ +
+
+app.mail
+
+ +
+
+app.database_cli
+
+ +
+
+app.create_database()
+
+ +
+
+app.delete_database()
+
+ +
+
+app.make_superuser_database()
+
+ +
+
+app.load_user(email)
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/misc_func/index.html b/docs/_build/html/autoapi/app/misc_func/index.html new file mode 100644 index 0000000..e003525 --- /dev/null +++ b/docs/_build/html/autoapi/app/misc_func/index.html @@ -0,0 +1,144 @@ + + + + + + + + + app.misc_func — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.misc_func

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + + + + +

flash_errors(form)

send(to, subject, body, body_html)

send_async(app, message)

+
+
+app.misc_func.flash_errors(form)
+
+ +
+
+app.misc_func.send(to, subject, body, body_html)
+
+ +
+
+app.misc_func.send_async(app, message)
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/models/index.html b/docs/_build/html/autoapi/app/models/index.html new file mode 100644 index 0000000..28c12c6 --- /dev/null +++ b/docs/_build/html/autoapi/app/models/index.html @@ -0,0 +1,216 @@ + + + + + + + + + app.models — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.models

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + +

User

This provides default implementations for the methods that Flask-Login

+
+
+class app.models.User
+

Bases: app.db.Model, flask_login.UserMixin

+

This provides default implementations for the methods that Flask-Login +expects user objects to have.

+
+
+__tablename__ = users
+
+ +
+
+first_name
+
+ +
+
+last_name
+
+ +
+
+email
+
+ +
+
+confirmation
+
+ +
+
+paid
+
+ +
+
+role
+
+ +
+
+team
+
+ +
+
+login_type
+
+ +
+
+_password
+
+ +
+
+property full_name(self)
+
+ +
+
+password(self)
+
+ +
+
+check_password(self, plaintext)
+
+ +
+
+get_id(self)
+
+ +
+
+get_role(self)
+
+ +
+
+get_team(self)
+
+ +
+
+is_paid(self)
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/conftest/index.html b/docs/_build/html/autoapi/app/tests/conftest/index.html new file mode 100644 index 0000000..cebd7c1 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/conftest/index.html @@ -0,0 +1,139 @@ + + + + + + + + + app.tests.conftest — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.conftest

+

Configuration with basic fixtures

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

app()

Special configurations for tests

client(app)

+
+
+app.tests.conftest.app()
+

Special configurations for tests

+

We use a dummy database and initialise it.

+
+ +
+
+app.tests.conftest.client(app)
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/index.html b/docs/_build/html/autoapi/app/tests/index.html new file mode 100644 index 0000000..6a33e0d --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/index.html @@ -0,0 +1,121 @@ + + + + + + + + + app.tests — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests

+

PyTest Modules for Unit Testing

+
+

Submodules

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_admin/index.html b/docs/_build/html/autoapi/app/tests/test_admin/index.html new file mode 100644 index 0000000..d556f2b --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_admin/index.html @@ -0,0 +1,132 @@ + + + + + + + + + app.tests.test_admin — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_admin

+

Test(s) for Admin Portal

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_admin(app, client)

Test Admin Portal

+
+
+app.tests.test_admin.test_admin(app, client)
+

Test Admin Portal

+

We use the cli-runner to run the admin-create command. +Then we check if the admin portal is accessible to the newly created superuser.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_cli/index.html b/docs/_build/html/autoapi/app/tests/test_cli/index.html new file mode 100644 index 0000000..dfb0d32 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_cli/index.html @@ -0,0 +1,131 @@ + + + + + + + + + app.tests.test_cli — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_cli

+

Test(s) for CLI Commands

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_database_commands(app, client)

Test for Database CLI Commands

+
+
+app.tests.test_cli.test_database_commands(app, client)
+

Test for Database CLI Commands

+

Test for initialisation, creation and admin user creation.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_fastapi/index.html b/docs/_build/html/autoapi/app/tests/test_fastapi/index.html new file mode 100644 index 0000000..d572949 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_fastapi/index.html @@ -0,0 +1,160 @@ + + + + + + + + + app.tests.test_fastapi — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_fastapi

+

Test(s) for FastAPI Inegration

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_fastapi(app, client)

Basic Version Test

test_fastapi_user_details(app, client)

Basic User Test

+
+
+

Attributes

+ ++++ + + + + + +

fastapi_client

+
+
+app.tests.test_fastapi.fastapi_client
+
+ +
+
+app.tests.test_fastapi.test_fastapi(app, client)
+

Basic Version Test

+

Check if endpoint is accessible

+
+ +
+
+app.tests.test_fastapi.test_fastapi_user_details(app, client)
+

Basic User Test

+

Check if DB is accessible to the FastAPI App

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_forms/index.html b/docs/_build/html/autoapi/app/tests/test_forms/index.html new file mode 100644 index 0000000..f1669c6 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_forms/index.html @@ -0,0 +1,140 @@ + + + + + + + + + app.tests.test_forms — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_forms

+

Test(s) for Forms

+

Tests the forms and their validations

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_incorrect_forms(app, client)

Simulate Invalid Forms

test_contactus(app, client)

Test Valid Form Submission

+
+
+app.tests.test_forms.test_incorrect_forms(app, client)
+

Simulate Invalid Forms

+
+ +
+
+app.tests.test_forms.test_contactus(app, client)
+

Test Valid Form Submission

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_models/index.html b/docs/_build/html/autoapi/app/tests/test_models/index.html new file mode 100644 index 0000000..597f207 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_models/index.html @@ -0,0 +1,130 @@ + + + + + + + + + app.tests.test_models — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_models

+

Test(s) for Database Models

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_usermodel(app, client)

Test User Model

+
+
+app.tests.test_models.test_usermodel(app, client)
+

Test User Model

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_views/index.html b/docs/_build/html/autoapi/app/tests/test_views/index.html new file mode 100644 index 0000000..bd4f362 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_views/index.html @@ -0,0 +1,169 @@ + + + + + + + + + app.tests.test_views — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_views

+

Test(s) for Flask Views

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_visitors(app, client)

Test if Vistors get expected endpoints and status codes

test_user_auth_flow(app, client)

Test User Authentication Flow

+
+
+

Attributes

+ ++++ + + + + + + + + +

ts

To create confirmation tokens

data2check_visitors

Dictionary of Path, Expected Status Code and Data to Test for Visitors

+
+
+app.tests.test_views.ts
+

To create confirmation tokens

+
+ +
+
+app.tests.test_views.data2check_visitors
+

Dictionary of Path, Expected Status Code and Data to Test for Visitors

+
+ +
+
+app.tests.test_views.test_visitors(app, client)
+

Test if Vistors get expected endpoints and status codes

+
+ +
+
+app.tests.test_views.test_user_auth_flow(app, client)
+

Test User Authentication Flow

+

Tests Registeration, Email-Confirmation and Log-in along with appropriate redirects.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/admin/index.html b/docs/_build/html/autoapi/app/views/admin/index.html new file mode 100644 index 0000000..5339b3a --- /dev/null +++ b/docs/_build/html/autoapi/app/views/admin/index.html @@ -0,0 +1,159 @@ + + + + + + + + + app.views.admin — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.admin

+

SuperUser/Admin portal using flask-admin

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + +

ModelView

Our extended ModelView Class

+
+
+

Attributes

+ ++++ + + + + + +

admin

Initialised Admin Portal

+
+
+app.views.admin.admin
+

Initialised Admin Portal

+
+ +
+
+class app.views.admin.ModelView(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)
+

Bases: flask_admin.contrib.sqla.ModelView

+

Our extended ModelView Class

+

Refer to Flask-Admin Docs for more details

+

https://flask-admin.readthedocs.io/en/latest/introduction/?highlight=ModelView#modelview-configuration-attributes

+
+
+is_accessible(self)
+

This function checks if a user should be given access or not

+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/auth/index.html b/docs/_build/html/autoapi/app/views/auth/index.html new file mode 100644 index 0000000..6a4a773 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/auth/index.html @@ -0,0 +1,203 @@ + + + + + + + + + app.views.auth — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.auth

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

register_user()

signin_user()

login_with_google()

login_with_google_auth()

confirm_email()

user_dashboard()

logout()

unauthorized()

+
+
+

Attributes

+ ++++ + + + + + +

ts

+
+
+app.views.auth.ts
+
+ +
+
+app.views.auth.register_user()
+
+ +
+
+app.views.auth.signin_user()
+
+ +
+
+app.views.auth.login_with_google()
+
+ +
+
+app.views.auth.login_with_google_auth()
+
+ +
+
+app.views.auth.confirm_email()
+
+ +
+
+app.views.auth.user_dashboard()
+
+ +
+
+app.views.auth.logout()
+
+ +
+
+app.views.auth.unauthorized()
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/error_pages/index.html b/docs/_build/html/autoapi/app/views/error_pages/index.html new file mode 100644 index 0000000..222d7e5 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/error_pages/index.html @@ -0,0 +1,157 @@ + + + + + + + + + app.views.error_pages — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.error_pages

+

This file describes the errors and the message the user should see.

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + + + + + + + +

simulate_500()

Used to simulate a error 500 for test coverage of 500 handling

page_forbidden(e)

Thrown when a user accesses a page with @flask_login.login_required

page_not_found(e)

Page for resource or file nout found

page_server_error(e)

Page for internal server error

+
+
+app.views.error_pages.simulate_500()
+

Used to simulate a error 500 for test coverage of 500 handling

+
+ +
+
+app.views.error_pages.page_forbidden(e)
+

Thrown when a user accesses a page with @flask_login.login_required

+
+ +
+
+app.views.error_pages.page_not_found(e)
+

Page for resource or file nout found

+
+ +
+
+app.views.error_pages.page_server_error(e)
+

Page for internal server error

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/index.html b/docs/_build/html/autoapi/app/views/index.html new file mode 100644 index 0000000..170f909 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/index.html @@ -0,0 +1,117 @@ + + + + + + + + + app.views — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views

+
+

Submodules

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/main/index.html b/docs/_build/html/autoapi/app/views/main/index.html new file mode 100644 index 0000000..8cf93f8 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/main/index.html @@ -0,0 +1,141 @@ + + + + + + + + + app.views.main — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.main

+

This is the main views module.

+

You should import all other views into this file rather than individually importing in __init__.py

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

index()

The view for the landing page.

contact_us()

A simple contact us form with basic validation.

+
+
+app.views.main.index()
+

The view for the landing page.

+
+ +
+
+app.views.main.contact_us()
+

A simple contact us form with basic validation.

+

This dummy form has not been linked to any database.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file -- cgit v1.2.3