timelink.mhk package

Subpackages

• timelink.mhk.models package
  • Submodules
  • timelink.mhk.models.act module
    • Act
      • Act.contains
      • Act.groupname
      • Act.id
      • Act.indexed
      • Act.inside
      • Act.loc
      • Act.obs
      • Act.pom_class
      • Act.ref
      • Act.the_date
      • Act.the_level
      • Act.the_line
      • Act.the_order
      • Act.the_type
      • Act.updated
  • timelink.mhk.models.attribute module
    • Attribute
      • Attribute.contains
      • Attribute.groupname
      • Attribute.id
      • Attribute.indexed
      • Attribute.inside
      • Attribute.pom_class
      • Attribute.the_level
      • Attribute.the_line
      • Attribute.the_order
      • Attribute.updated
  • timelink.mhk.models.base module
  • timelink.mhk.models.base_class module
    • Base
      • Base.metadata
      • Base.registry
  • timelink.mhk.models.base_mappings module
  • timelink.mhk.models.db module
    • TimelinkDB
    • TimelinkMHK
      • TimelinkMHK.create_tables()
      • TimelinkMHK.drop_db()
      • TimelinkMHK.ensure_all_mappings()
      • TimelinkMHK.get_engine()
      • TimelinkMHK.get_metadata()
      • TimelinkMHK.get_session()
      • TimelinkMHK.init_db()
      • TimelinkMHK.load_database_classes()
      • TimelinkMHK.sa_engine()
      • TimelinkMHK.table_names()
  • timelink.mhk.models.entity module
    • Entity
      • Entity.contains
      • Entity.get_entity()
      • Entity.get_orm_entities_classes()
      • Entity.get_orm_for_pom_class()
      • Entity.get_orm_for_table()
      • Entity.get_som_mapper_ids()
      • Entity.get_som_mapper_to_orm_as_dict()
      • Entity.get_subclasses()
      • Entity.get_tables_to_orm_as_dict()
      • Entity.groupname
      • Entity.id
      • Entity.indexed
      • Entity.inside
      • Entity.pom_class
      • Entity.the_level
      • Entity.the_line
      • Entity.the_order
      • Entity.updated
  • timelink.mhk.models.object module
    • Object
      • Object.contains
      • Object.groupname
      • Object.id
      • Object.indexed
      • Object.inside
      • Object.pom_class
      • Object.the_level
      • Object.the_line
      • Object.the_order
      • Object.updated
  • timelink.mhk.models.person module
    • Person
      • Person.contains
      • Person.groupname
      • Person.id
      • Person.indexed
      • Person.inside
      • Person.pom_class
      • Person.the_level
      • Person.the_line
      • Person.the_order
      • Person.updated
  • timelink.mhk.models.pom_som_mapper module
    • PomClassAttributes
    • PomSomMapper
      • PomSomMapper.contains
      • PomSomMapper.element_class_to_column()
      • PomSomMapper.ensure_all_mappings()
      • PomSomMapper.ensure_mapping()
      • PomSomMapper.get_pom_class()
      • PomSomMapper.get_pom_class_ids()
      • PomSomMapper.get_pom_classes()
      • PomSomMapper.groupname
      • PomSomMapper.id
      • PomSomMapper.indexed
      • PomSomMapper.inside
      • PomSomMapper.kgroup_to_entity()
      • PomSomMapper.pom_class
      • PomSomMapper.the_level
      • PomSomMapper.the_line
      • PomSomMapper.the_order
      • PomSomMapper.updated
  • timelink.mhk.models.relation module
    • Relation
      • Relation.contains
      • Relation.groupname
      • Relation.id
      • Relation.indexed
      • Relation.inside
      • Relation.pom_class
      • Relation.the_level
      • Relation.the_line
      • Relation.the_order
      • Relation.updated
  • timelink.mhk.models.source module
    • Source
      • Source.contains
      • Source.groupname
      • Source.id
      • Source.indexed
      • Source.inside
      • Source.pom_class
      • Source.the_level
      • Source.the_line
      • Source.the_order
      • Source.updated
  • timelink.mhk.models.system module
    • KleioImportedFile
    • LogLevel
    • ParTypeSchema
    • SysLog
    • SysLogCreateSchema
      • SysLogCreateSchema.model_computed_fields
      • SysLogCreateSchema.model_config
      • SysLogCreateSchema.model_fields
    • SysLogSchema
      • SysLogSchema.model_computed_fields
      • SysLogSchema.model_config
      • SysLogSchema.model_fields
    • SysPar
    • SysParSchema
      • SysParSchema.model_computed_fields
      • SysParSchema.model_config
      • SysParSchema.model_fields

Submodules

timelink.mhk.utilities module

Utilities for interaction with and MHK installation.

MHK is the name of Java Webapp that preceded Timelink.

3. Joaquim Carvalho, 2021. MIT Licence.

timelink.mhk.utilities.get_db_pwd() → str

Get the password of the database from the MHK environment

timelink.mhk.utilities.get_dbnames()

Get the names of MHK databases in MySQL

A search is made in the MySQL server running in the local host port 3307

timelink.mhk.utilities.get_env_as_dict(filename: str) → dict

Reads environment variables from a file and return a SafeConfig object

Rationale: SafeConfig parser requires :param filename: Name of a file :return:

timelink.mhk.utilities.get_mhk_app_env() → Type[str | None]

Get the mhk app environment variables from mhk-home/app/.env

The .env filed contains information used by docker to create the MHK application and some running options, like header color and docker image tags used for updates.

The .env file is created by the MHK installation process. Its contents can be changed my mhk manager commands.

timelink.mhk.utilities.get_mhk_db_pwd()

Get the password of the database from the MHK environment

timelink.mhk.utilities.get_mhk_env() → Type[str | None]

Get the MHK environment variables from ~/.mhk

The .mhk file contains the path for the mhk-home of the current user. It is created by the MHK install process.

timelink.mhk.utilities.is_mhk_installed() → bool

Returns true if a MHK instalation is found

Checks the existence of ~/.mhk

timelink.mhk.utilities.remove_quotes(original)

Removes quotes from quoted values in env variables See https://stackoverflow.com/a/50772706 :param original: dict with env variables :return: copy of the dict with the values unquoted