Overview

The tracking_lib is a python module that is used by the PA development team to orchestrate the control messages that are sent in the Control Channel. It uses the Web Frameworks' (Flask, FastAPI) feature to keep a state in the request lifecycle in order to maintain and communicate a transaction id among different services. The following section describes the supprted features.

Features

Create and store a Transaction id
Sent status messages for SUCCESS or FAILURE

Installation

pip install tracking-lib

How to use it

import os

from tracking_lib.config import Config
from tracking_lib.transaction import Transaction
from flask import Flask, jsonify

app = Flask(__name__)


def interactor_runc():
    # print(f"transaction_id in interactor func: {Transaction.read_transaction_id()}")
    return Transaction.read_transaction_id()


@app.route("/")
def hello_world_success():
    Transaction.init(Config(
         downstream_service="TVDI_CONFIGS_MANAGER",
        control_channel_project_id=os.getenv("CONTROL_CHANNEL_PROJECT_ID"),
        control_channel_topic_id=os.getenv("CONTROL_CHANNEL_TOPIC_ID")

    ))
    Transaction.set_transaction_id("123456")
    tr_id = interactor_runc()
    Transaction.set_transaction_status(src_event_name="AN_SRC_EVENT_NAME")
    return jsonify(message=tr_id)

Metadata

Release files for tracking-lib 0.1.30

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tracking-lib 0.1.30
File	Size	Uploaded
tracking_lib-0.1.30.tar.gz	5.9 kB	Apr 3, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for tracking-lib 0.1.30
File	Interpreter	ABI	Platform	Reset
tracking_lib-0.1.30-py3-none-any.whl 8.7 kB Apr 3, 2024	Python 3	none	any	Details

Total release size: 14.6 kB

Release files / tracking_lib-0.1.30.tar.gz

Download URL	tracking_lib-0.1.30.tar.gz
Size	5.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`c4695d246d7e585af0ec9d4e1ded957bd035967cf538e883ca87c9c1ca0d0b74`
BLAKE2b-256 checksum How to use checksums	`c5e4e536e251f05f0702622d6904c03956390cd80c2cf4d5824c787ed67e60f4`
Upload date	Apr 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.0.0 CPython/3.12.2`

Release files / tracking_lib-0.1.30-py3-none-any.whl

Download URL	tracking_lib-0.1.30-py3-none-any.whl
Size	8.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f3bc7eb9940fbe86aa25af2709aa23b7e0ef3647da15926a3f334df4dca19830`
BLAKE2b-256 checksum How to use checksums	`ca1113ff0f830497f4e25a6222acf1f627fcff8f5915872fee1146247c043ac0`
Upload date	Apr 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.0.0 CPython/3.12.2`