tracdap-ext-git 0.10.0rc1

An extension for TRAC D.A.P. that loads models from Git repositories

Homepage ◆ Documentation ◆ Examples ◆ Source Code ◆ Issue Tracker

Git Extension for the TRAC Model Runtime

This extension allows TRAC to load models dynamically from Git repositories.

• Includes a pure-Python implementation using the excellent dulwich library
• Includes a native Git implementation that wraps a Git binaries on the host system
• Support for private repositories using tokens
• Handles corporate firewalls, proxies and SSL

This extension is a pre-release and will be finalized inTRAC 0.10.

Installing

The HTTP extension can be installed with pip:

$ pip install tracdap-ext-git

The package has the following dependencies:

• tracdap-runtime (version 0.10.0-beta2 or later)
• dulwich (0.24.x series)
• urllib3 (version 2.2 or later)

Using the Git model repository

With the Git extension installed, you can add a Git model repository as a resource in sys_config.yaml like this:

resources:

  my_repository:
    resourceType: MODEL_REPOSITORY
    protocol: git
    properties:
      repoUrl: https://github.com/a-user/my-repository

By default the extension will use the pure-python implementation of Git, to use native Git binaries set nativeGit: true as a property on the repository. To supply credentials, use either the username and password properties, or the token property. In production deployments these properties should be supplied using the TRAC secrets mechanism.

Using the pure-Python implementation, all of TRAC's network properties are respected. In particular, to supply an enterprise root trust certificate you can set network.ssl.caCertificates to the path of a certificate in PEM format. Setting network.ssl.publicCertificates: true will include the global, public CAs in addition to the enterprise root.

All properties starting with the prefix git. are treated as Git configuration and written into the Git config file for the repository when it is checked out. For example, setting git.http.sslCAInfo will set the sslCAInfo property in the http section of the Git configuration. This is an alternate way of specifying SSL details that works with the native Git implementation, but can also be used to set arbitrary Git configuration values with either implementation. Some Git config values may not be respected by Dulwich, so it is recommended to use the TRAC config settings with the pure-Python implementation and native Git config settings with the native Git implementation.