timelink package

Timelink Python package.

Timelink, formerly known as MHK (Micro History with Kleio) is an information system designed for processing person related information collected from historical sources.

Subpackages

• timelink.api package
  • Subpackages
    • timelink.api.models package
      • Submodules
      • timelink.api.models.act module
      • timelink.api.models.attribute module
      • timelink.api.models.base module
      • timelink.api.models.base_class module
      • timelink.api.models.base_mappings module
      • timelink.api.models.entity module
      • timelink.api.models.object module
      • timelink.api.models.person module
      • timelink.api.models.pom_som_mapper module
      • timelink.api.models.relation module
      • timelink.api.models.source module
      • timelink.api.models.system module
  • Submodules
  • timelink.api.crud module
    • get()
    • get_syslog()
    • get_syslog_by_time()
    • get_syspar()
    • set_syslog()
    • set_syspar()
  • timelink.api.database module
    • TimelinkDatabase
      • TimelinkDatabase.db_url
      • TimelinkDatabase.db_name
      • TimelinkDatabase.db_user
      • TimelinkDatabase.db_pwd
      • TimelinkDatabase.engine
      • TimelinkDatabase.session
      • TimelinkDatabase.metadata
      • TimelinkDatabase.db_container
      • TimelinkDatabase.kserver
      • TimelinkDatabase.create_db()
      • TimelinkDatabase.create_tables()
      • TimelinkDatabase.create_views()
      • TimelinkDatabase.describe()
      • TimelinkDatabase.drop_db()
      • TimelinkDatabase.ensure_all_mappings()
      • TimelinkDatabase.export_as_kleio()
      • TimelinkDatabase.get_columns()
      • TimelinkDatabase.get_db()
      • TimelinkDatabase.get_eattribute_view()
      • TimelinkDatabase.get_engine()
      • TimelinkDatabase.get_entity()
      • TimelinkDatabase.get_import_rpt()
      • TimelinkDatabase.get_import_status()
      • TimelinkDatabase.get_imported_files()
      • TimelinkDatabase.get_kleio_server()
      • TimelinkDatabase.get_metadata()
      • TimelinkDatabase.get_model()
      • TimelinkDatabase.get_model_by_name()
      • TimelinkDatabase.get_models_ids()
      • TimelinkDatabase.get_need_import()
      • TimelinkDatabase.get_pattribute_view()
      • TimelinkDatabase.get_person()
      • TimelinkDatabase.get_table()
      • TimelinkDatabase.load_database_classes()
      • TimelinkDatabase.pperson()
      • TimelinkDatabase.query()
      • TimelinkDatabase.set_kleio_server()
      • TimelinkDatabase.table_names()
      • TimelinkDatabase.table_row_count()
      • TimelinkDatabase.update_from_sources()
  • timelink.api.schemas module
    • AttributeSchema
      • AttributeSchema.model_config
    • EntityAttrRelSchema
      • EntityAttrRelSchema.model_config
    • EntityBriefSchema
      • EntityBriefSchema.model_config
    • EntitySchema
      • EntitySchema.model_config
    • ImportStats
      • ImportStats.model_config
    • RelationInSchema
      • RelationInSchema.model_config
    • RelationOutSchema
      • RelationOutSchema.model_config
    • RelationSchema
      • RelationSchema.model_config
    • SearchRequest
      • SearchRequest.model_config
    • SearchResults
      • SearchResults.model_config
  • timelink.api.views module
    • CreateView
    • DropView
    • view()
• timelink.app package
  • Subpackages
    • timelink.app.backend package
      • Submodules
      • timelink.app.backend.settings module
      • timelink.app.backend.timelink_webapp module
    • timelink.app.models package
      • Submodules
      • timelink.app.models.user module
      • timelink.app.models.user_database module
    • timelink.app.schemas package
      • Submodules
      • timelink.app.schemas.project module
      • timelink.app.schemas.user module
    • timelink.app.services package
      • Submodules
      • timelink.app.services.auth module
      • timelink.app.services.syslog module
      • timelink.app.services.syspar module
    • timelink.app.web package
      • Submodules
      • timelink.app.web.home_page module
      • timelink.app.web.login_page module
      • timelink.app.web.projects_page module
      • timelink.app.web.webapp_info module
  • Submodules
  • timelink.app.dependencies module
  • timelink.app.main module
• timelink.kleio package
  • Subpackages
    • timelink.kleio.groups package
      • Submodules
      • timelink.kleio.groups.kabstraction module
      • timelink.kleio.groups.kact module
      • timelink.kleio.groups.katr module
      • timelink.kleio.groups.kattribute module
      • timelink.kleio.groups.kelement module
      • timelink.kleio.groups.kgroup module
      • timelink.kleio.groups.kkleio module
      • timelink.kleio.groups.kls module
      • timelink.kleio.groups.kobject module
      • timelink.kleio.groups.kperson module
      • timelink.kleio.groups.krelation module
      • timelink.kleio.groups.ksource module
  • Submodules
  • timelink.kleio.importer module
    • import_from_xml()
  • timelink.kleio.kleio_server module
    • KleioServer
      • KleioServer.attach()
      • KleioServer.call()
      • KleioServer.container
      • KleioServer.find_local_kleio_home()
      • KleioServer.generate_token()
      • KleioServer.get_container()
      • KleioServer.get_home_page()
      • KleioServer.get_kleio_home()
      • KleioServer.get_logs()
      • KleioServer.get_report()
      • KleioServer.get_server()
      • KleioServer.get_sources()
      • KleioServer.get_token()
      • KleioServer.get_translations()
      • KleioServer.get_url()
      • KleioServer.get_url_content()
      • KleioServer.host
      • KleioServer.invalidate_user()
      • KleioServer.is_server_running()
      • KleioServer.kleio_admin_token
      • KleioServer.kleio_home
      • KleioServer.make_token()
      • KleioServer.start()
      • KleioServer.stop()
      • KleioServer.translate()
      • KleioServer.translation_clean()
      • KleioServer.url
    • KleioServerDockerException
    • KleioServerException
    • KleioServerForbidenException
    • find_local_kleio_home()
    • get_kserver_container()
    • get_kserver_container_list()
    • get_kserver_home()
    • get_kserver_token()
    • is_docker_running()
    • list_kleio_server_containers()
    • random_token()
    • start_kleio_server()
    • stop_kleio_server()
  • timelink.kleio.schemas module
    • ApiPermissions
    • KleioFile
      • KleioFile.model_config
      • KleioFile.needs_import()
      • KleioFile.needs_translation()
      • KleioFile.source_url
    • TokenInfo
      • TokenInfo.model_config
    • import_status_enum
    • translation_status_enum
  • timelink.kleio.utilities module
    • convert_timelink_date()
    • format_timelink_date()
    • get_extra_info_from_obs()
    • kleio_escape()
    • quote_long_text()
    • render_with_extra_info()
• timelink.mhk package
  • Subpackages
    • timelink.mhk.models package
      • Submodules
      • timelink.mhk.models.act module
      • timelink.mhk.models.attribute module
      • timelink.mhk.models.base module
      • timelink.mhk.models.base_class module
      • timelink.mhk.models.base_mappings module
      • timelink.mhk.models.db module
      • timelink.mhk.models.entity module
      • timelink.mhk.models.object module
      • timelink.mhk.models.person module
      • timelink.mhk.models.pom_som_mapper module
      • timelink.mhk.models.relation module
      • timelink.mhk.models.source module
      • timelink.mhk.models.system module
  • Submodules
  • timelink.mhk.utilities module
    • get_db_pwd()
    • get_dbnames()
    • get_env_as_dict()
    • get_mhk_app_env()
    • get_mhk_db_pwd()
    • get_mhk_env()
    • is_mhk_installed()
    • remove_quotes()
• timelink.migrations package
  • autogenerate()
  • current()
  • downgrade()
  • get_versions()
  • heads()
  • history()
  • revision()
  • set_db_url()
  • stamp()
  • upgrade()
  • Submodules
  • timelink.migrations.env module
• timelink.networks package
  • Submodules
  • timelink.networks.network_draw module
  • timelink.networks.network_generation module
• timelink.notebooks package
  • Submodules
  • timelink.notebooks.timelink_notebook module
    • TimelinkNotebook
      • TimelinkNotebook.get_file_paths()
      • TimelinkNotebook.get_import_rpt()
      • TimelinkNotebook.get_import_status()
      • TimelinkNotebook.get_imported_files()
      • TimelinkNotebook.get_kleio_files()
      • TimelinkNotebook.get_postgres_databases()
      • TimelinkNotebook.get_sqlite_databases()
      • TimelinkNotebook.get_translation_report()
      • TimelinkNotebook.print_info()
      • TimelinkNotebook.table_row_count_df()
      • TimelinkNotebook.update_from_sources()
• timelink.pandas package
  • Submodules
  • timelink.pandas.attribute_values module
    • attribute_values()
  • timelink.pandas.name_to_df module
    • pname_to_df()
• timelink.static package
• timelink.statics package

Submodules

timelink.cli module

Console script for timelink.

Also provides basic mhk manager functionality.

Run with python -m timelink.cli

timelink.cli.create_db_index(avoid_patterns=None)

Create a dictionary of databases

Parameters:

avoid_patterns (list) – list of patterns to avoid in the database name

Returns:

dictionary of databases, key is an integer,

value is a tuple of the form: (db_type, db_name, db_url)

Return type:

dict

timelink.cli.db_autogenerate(db_url: str, message: str)

Create a new migration script

timelink.cli.db_create_cmd(db_url: str = <typer.models.ArgumentInfo object>)

Create a new database

timelink.cli.db_current_cmd(db_url: str, verbose: str = '--verbose')

Display current database revision

timelink.cli.db_database_list_cmd()

List all available databases (sqlite, postgresql, etc)

timelink.cli.db_heads(db_url: str)

Return the head(s) (current revision)

see: https://alembic.sqlalchemy.org/en/latest/api/runtime.html#alembic.runtime.migration.MigrationContext.get_current_heads

timelink.cli.db_history(verbose: bool = False)

Show the migration history

timelink.cli.db_revision(db_url: str, message: str)

Create a new migration script

timelink.cli.db_stamp(db_url: str, revision: str)

Stamp the database to a given revision. Use ‘heads’ to mark the database as up-to-date

timelink.cli.db_upgrade_cmd(db_url: str, revision: str = 'heads')

Update database to (most recent) revision

timelink.cli.main()

This is the timelink/MHK manager on the command line

timelink.cli.mhk_status()

shows docker status information

timelink.cli.mhk_version()

shows MHK manager version

Demonstrates how to access MHK installation files and usage of Docker API

timelink.cli.start()

Starts timelink with uvicorn

timelink.timelink module

Main module.

This is in timelink.py file