Prerequisites and Installations

Split Fixture Python

Configure pip to pull from the engagement repository (trimblecloudplatform-engagement-pypi) on the eTools Artifactory and run the command pipx install splitfixture.

Instead of configuring pip, you can also add this information to the pip command:

pip install --index-url="https://<USERNAME>:<ETOOLS-API-KEY>@artifactory.trimble.tools/artifactory/api/pypi/trimblecloudplatform-engagement-pypi/simple" --extra-index-url=https://pypi.python.org/simple splitfixture

USERNAME: Your trimble email address with the @ sign encoded as %40 (ie. firstname_lastname%40trimble.com)
ETOOLS_API_KEY: Your artifactory api key, which can be found here

Split Fixture Docker Image

The split fixture Docker images are available on Trimble’s Docker Hub. The OS Version is specified in the image tags (ie windows-latest and linux-latest). To get an image locally (windows for example) run the command:

docker pull trimble/pf-splitfixture:windows-latest

If you are using Docker Desktop ensure you are signed in to your Docker account through Okta and then use the Docker Desktop app to sign in to the same account. Docker Desktop should open a web prompt that will authenticate with Dockerhub and redirect you back to the Desktop app. If you do not already have access to Trimble’s Docker Hub, you can submit a Software License Request ticket to the Licensing Department at cisjira.trimble.com.

If you are using the Docker cli then you will need to provide an access token to authenticate with Docker hub. Instructions for creating and using an access token to log in are available in the Docker documentation. The command to log in with the cli is

docker login -u <username>

username: Your Docker hub username.

Provide the access token when prompted for a password.

TD Split Engine

Similar to the split fixture package above the tdsplitengine package is also available through eTools Artifactory.

pip install --index-url="https://<USERNAME>:<ETOOLS-API-KEY>@artifactory.trimble.tools/artifactory/api/pypi/trimblecloudplatform-engagement-pypi/simple" --extra-index-url=https://pypi.python.org/simple tdsplitengine

USERNAME: Your trimble email address with the @ sign encoded as %40 (ie. firstname_lastname%40trimble.com)
ETOOLS_API_KEY: Your artifactory api key, which can be found here

Integrity Checker Engine

The integritychecker sample engine is available in the PE project in Bitbucket. Clone the repository with

git clone ssh://git@bitbucket.trimble.tools/pe/engine-integritychecker.git