Timelink Python package
v1.0.5

Contents:

  • The Timelink python package
  • Installation
  • Usage
  • Documentation
  • Timelink source documentation
    • timelink package
      • Subpackages
        • timelink.api package
        • timelink.kleio package
        • timelink.mhk package
        • timelink.networks package
        • timelink.notebooks package
        • timelink.pandas package
      • Submodules
      • timelink.cli module
      • timelink.timelink module
  • Contributing
  • Credits
  • History
Timelink Python package
  • Timelink source documentation
  • timelink package
  • Edit on GitHub

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
    • timelink.api.main module
    • timelink.api.schemas module
      • AttributeSchema
        • AttributeSchema.model_computed_fields
        • AttributeSchema.model_config
        • AttributeSchema.model_fields
      • EntityAttrRelSchema
        • EntityAttrRelSchema.model_computed_fields
        • EntityAttrRelSchema.model_config
        • EntityAttrRelSchema.model_fields
      • EntityBriefSchema
        • EntityBriefSchema.model_computed_fields
        • EntityBriefSchema.model_config
        • EntityBriefSchema.model_fields
      • EntitySchema
        • EntitySchema.model_computed_fields
        • EntitySchema.model_config
        • EntitySchema.model_fields
      • ImportStats
        • ImportStats.model_computed_fields
        • ImportStats.model_config
        • ImportStats.model_fields
      • RelationInSchema
        • RelationInSchema.model_computed_fields
        • RelationInSchema.model_config
        • RelationInSchema.model_fields
      • RelationOutSchema
        • RelationOutSchema.model_computed_fields
        • RelationOutSchema.model_config
        • RelationOutSchema.model_fields
      • RelationSchema
        • RelationSchema.model_computed_fields
        • RelationSchema.model_config
        • RelationSchema.model_fields
      • SearchRequest
        • SearchRequest.model_computed_fields
        • SearchRequest.model_config
        • SearchRequest.model_fields
      • SearchResults
        • SearchResults.model_computed_fields
        • SearchResults.model_config
        • SearchResults.model_fields
    • timelink.api.views module
      • CreateView
      • DropView
      • view()
  • 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
      • KleioContext
      • SaxHandler
        • SaxHandler.characters()
        • SaxHandler.endDocument()
        • SaxHandler.endElement()
        • SaxHandler.ignorableWhitespace()
        • SaxHandler.processingInstruction()
        • SaxHandler.startDocument()
        • SaxHandler.startElement()
      • 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_kleio_home()
        • KleioServer.get_report()
        • KleioServer.get_server()
        • KleioServer.get_sources()
        • KleioServer.get_token()
        • KleioServer.get_url()
        • KleioServer.get_url_content()
        • KleioServer.host
        • KleioServer.invalidate_user()
        • KleioServer.is_server_running()
        • KleioServer.kleio_home
        • KleioServer.make_token()
        • KleioServer.start()
        • KleioServer.stop()
        • KleioServer.token
        • KleioServer.translate()
        • KleioServer.translation_clean()
        • KleioServer.translation_status()
        • KleioServer.url
      • find_local_kleio_home()
      • get_kserver_container()
      • get_kserver_container_list()
      • get_kserver_home()
      • get_kserver_token()
      • is_docker_running()
      • random_token()
      • start_kleio_server()
      • stop_kleio_server()
    • timelink.kleio.schemas module
      • ApiPermissions
      • KleioFile
        • KleioFile.model_computed_fields
        • KleioFile.model_config
        • KleioFile.model_fields
        • KleioFile.needs_import()
        • KleioFile.needs_translation()
        • KleioFile.source_url
      • TokenInfo
        • TokenInfo.model_computed_fields
        • TokenInfo.model_config
        • TokenInfo.model_fields
      • import_status_enum
      • translation_status_enum
    • timelink.kleio.utilities module
      • kleio_escape()
      • quote_long_text()
  • 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.networks package
    • Submodules
    • timelink.networks.network_draw module
    • timelink.networks.network_generation module
  • timelink.notebooks package
    • Submodules
    • timelink.notebooks.timelink_notebook module
  • timelink.pandas package
    • Submodules
    • timelink.pandas.attribute_values module
    • timelink.pandas.name_to_df module

Submodules

timelink.cli module

timelink.timelink module

Main module.

This is in timelink.py file

Previous Next

© Copyright 2024, Joaquim Ramos de Carvalho. Revision 4cbf6bd0.

Built with Sphinx using a theme provided by Read the Docs.