Homepage ◆ Documentation ◆ Examples ◆ Source Code ◆ Issue Tracker

PyPI Extension for the TRAC Model Runtime

This extension allows the tracdap-runtime to load models dynamically from PyPI repositories, or a compatible proxy such as Nexus or Artifactory.

• Support for JSON, Simple JSON and Simple HTML query formats
• Support for private repositories using tokens
• Handles corporate firewalls, proxies and SSL

Installing

The HTTP extension can be installed with pip:

$ pip install tracdap-ext-pypi

The package has the following dependencies:

• tracdap-runtime (version 0.10.0-beta2 or later)
• urllib3 (optional, version 2.x)

Using the Git model repository

With the PyPI extension installed, you can add PyPI repositories as resources in sys_config.yaml like this:

resources:
  
  my_json_repository:
    resourceType: MODEL_REPOSITORY
    protocol: pypi
    properties:
      pipIndex: https://artifactory.mycompany.com/artifactory/api/pypi

  my_simple_repository:
    resourceType: MODEL_REPOSITORY
    protocol: pypi
    properties:
      pipIndexUrl: https://nexus.mycompany.com/repository/pypi/simple
      pipSimpleFormat: html

The examples show the use of both the JSON and Simple query formats. The particular query formats available and the paths for the index and index-url properties will depend on how your package server is configured. This information is often published along with other internal developer documentation to help set up a development environment (Look for the "index" or "index-url" settings when setting up other Python tools). Sometimes is is also visible in the web interface of the package server. If you can't find the settings you will need to contact your dev-ops team.

For the simple query format (i.e. an index configured with the "index-url" setting), there are two possible response formats: pipSimpleFormat: html or pipSimpleFormat: json. Use this setting to see what is available on your package server. For the JSON query format (i.e. an index configured with the "index" setting) there is only one response format available so this is not configurable.

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.

This extension assumes that packages on the package server are available as Python wheels.