SAD¶

Overview¶

The project to build the python client

SAD - System architechture design¶

Logic View¶

flowchart LR
  client[Python Submarine Client] -- interactive --> api[API Client]

For the API client, it served at following table

Development¶

Tech Stack¶

• Build package using hatch

• Storage and CICD using GitHub and GitHub Action

• Enforce code-regulation by pre-commit

• Using ruff for code QA.

• Build client using modern HTTP client of HTTPX

• Package builded by hatch

• Code Storage in GitHub

• Config Editor using EditorConfig

• Documentation by mkdocs on mkdocs-material theme

Operation¶

For deployment test in schedule¶

• Build test based on scheduler that trigger test on production

flowchart LR
  hatch[hatch test]
  otter[otter]
  channel[#0-test-application]
  bucket["bucket"]
  queue["queue"]
  executor["executor"]

  subgraph gb["Cloud Build"]
  hatch
  end

  subgraph gs["Cloud Storage"]
  bucket
  end

  subgraph wf["Workflow"]
  queue --> executor
  end

  subgraph inno_trans["inno-transflow"]
  otter
  end

  subgraph slack["Slack"]
  channel
  end

  gb --> |save output to file json| bucket
  bucket --> |execute| queue
  executor --> |trigger| otter
  otter --> |send message| channel

Service Account and Permissions¶

Support¶

Clean the cache and related to build

make clean

Appendix¶

Appendix A: Record of Changes¶

Table: Record of changes