app.utilities package

Subpackages

• app.utilities.databases package
  • Submodules
  • app.utilities.databases.sct_db module
    • sct_db.py
    • init_app_database()
    • init_audit_database()
  • app.utilities.databases.sct_mysql module
    • sct_db.py
    • DbBackEnd
      • DbBackEnd.add_audit()
      • DbBackEnd.add_table_record()
      • DbBackEnd.bulk_load_table_records()
      • DbBackEnd.create_audit_table()
      • DbBackEnd.db_connection
      • DbBackEnd.drop_table_record()
      • DbBackEnd.edit_table_record()
      • DbBackEnd.finalize()
      • DbBackEnd.get_audits()
      • DbBackEnd.get_cursor
      • DbBackEnd.get_pending_bulk_loading()
      • DbBackEnd.get_table_columns()
      • DbBackEnd.get_table_data()
      • DbBackEnd.get_table_info()
      • DbBackEnd.get_table_list()
      • DbBackEnd.search_audits()
      • DbBackEnd.search_table_data()
      • DbBackEnd.search_table_info()
  • app.utilities.databases.sct_mysql_query module
    • sct_mysql_query.py
  • app.utilities.databases.sct_postgres module
    • sct_db.py
    • DbBackEnd
      • DbBackEnd.add_audit()
      • DbBackEnd.add_table_record()
      • DbBackEnd.bulk_load_table_records()
      • DbBackEnd.create_audit_table()
      • DbBackEnd.db_connection
      • DbBackEnd.drop_table_record()
      • DbBackEnd.edit_table_record()
      • DbBackEnd.finalize()
      • DbBackEnd.get_audits()
      • DbBackEnd.get_cursor
      • DbBackEnd.get_pending_bulk_loading()
      • DbBackEnd.get_table_columns()
      • DbBackEnd.get_table_data()
      • DbBackEnd.get_table_info()
      • DbBackEnd.get_table_list()
      • DbBackEnd.search_audits()
      • DbBackEnd.search_table_data()
      • DbBackEnd.search_table_info()
  • app.utilities.databases.sct_postgres_query module
    • sct_query.py
  • app.utilities.databases.sct_sqlite module
    • sct_sqlite.py
    • DbBackEnd
      • DbBackEnd.add_audit()
      • DbBackEnd.add_table_record()
      • DbBackEnd.bulk_load_table_records()
      • DbBackEnd.create_audit_table()
      • DbBackEnd.db_connection
      • DbBackEnd.drop_table_record()
      • DbBackEnd.edit_table_record()
      • DbBackEnd.finalize()
      • DbBackEnd.get_audits()
      • DbBackEnd.get_cursor
      • DbBackEnd.get_pending_bulk_loading()
      • DbBackEnd.get_table_columns()
      • DbBackEnd.get_table_data()
      • DbBackEnd.get_table_info()
      • DbBackEnd.get_table_list()
      • DbBackEnd.search_audits()
      • DbBackEnd.search_table_data()
      • DbBackEnd.search_table_info()
  • app.utilities.databases.sct_sqlite_query module
    • sct_sqlite_query.py
  • Module contents

Submodules

app.utilities.sct_env module

sct_env.py

Environment setup script

app.utilities.sct_logging module

sct_logging.py

Logger setup script

app.utilities.sct_mail module

sct_mail.py

This module consists of mail utilities

app.utilities.sct_mail.enable_email_support(app)

Mail support

Parameters:

app – Application instance

Returns:

None

app.utilities.sct_mail.send_mail(app, **kwargs)

Send email

Parameters:

• app – Application instance

• kwargs – Mail argument

Returns:

None

app.utilities.sct_schedules module

sct_schedules.py

This module consists of schedule tasks

app.utilities.sct_schedules.sct_scheduled_bulk_loader(app)

SCT Tool Scheduled Tasks

Parameters:

app – Application instance

Returns:

None

app.utilities.sct_security module

app.utilities.sct_security.define_security(app, login_manager)

Application Security

Parameters:

• app – Flask application object

• login_manager – Database Interface Object <DbBackEnd>

Returns:

None

app.utilities.sct_security.get_user_role(user)

Return the role for a given user

Parameters:

user – User email

Returns:

Role

app.utilities.sct_user module

class app.utilities.sct_user.User(id_, name, email)

Bases: UserMixin

Custom User class.

claims()

Use this method to render all assigned claims on profile page.

static create(user_id, name, email)

static get(user_id)

app.utilities.sct_utils module

sct_utils.py

This module consists of utility functions used by other module

app.utilities.sct_utils.tuple_to_dict(key_list: list, tuple_list: list) → list

Converts a tuple list and a list of dictionary keys returning dictionary

Parameters:

• key_list – Dictionary keys

• tuple_list – List of tuples

Returns:

List of Dictionary

app.utilities.sct_utils.tuple_to_list(tuple_list: list) → list

Converts a list of single item tuple to a simple python list

Parameters:

tuple_list – Single element tuple

Returns:

List of elements

Module contents