# bu-isciii/buisciii-tools architecture

> Architecture diagram of the GitHub repository bu-isciii/buisciii-tools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bu-isciii/buisciii-tools
- Repository: https://github.com/bu-isciii/buisciii-tools

## Overview

buisciii-tools is a command-line toolkit for managing bioinformatics services alongside the iSkyLIMS LIMS. The main workflow is to select a service and resolution, create a service folder from its pipeline template, run or stage work via scratch, then clean, document, deliver, or archive it. The repository also includes service listing and SFTP maintenance. The graph reflects documented commands and shown references; where implementation excerpts are incomplete, it avoids inferring detailed data flows.

Main entry points: [`buisciii/__main__.py`](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/__main__.py) (Command dispatcher), [`buisciii/new_service.py`](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/new_service.py) (Create service), [`buisciii/drylab_api.py`](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/drylab_api.py) (iSkyLIMS API), [`buisciii/scratch.py`](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/scratch.py) (Scratch staging)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and setup"]
  node_cli["Command dispatcher<br/>[__main__.py]"]
  node_settings["Runtime settings<br/>[config_json.py]"]
  node_service_catalog["Service catalog<br/>[service_json.py]"]
  node_list["List services<br/>[list.py]"]
end

subgraph group_service["Service lifecycle"]
  node_create["Create service<br/>[new_service.py]"]
  node_templates["Pipeline templates"]
  node_scratch["Scratch staging<br/>[scratch.py]"]
  node_cleanup["Service cleanup<br/>[clean.py]"]
  node_archive["Archive services<br/>[archive.py]"]
end

subgraph group_delivery["Documentation and delivery"]
  node_sftp_copy["SFTP delivery<br/>[copy_sftp.py]"]
  node_sftp_clean["SFTP cleanup<br/>[autoclean_sftp.py]"]
  node_docs["Service documentation<br/>[bioinfo_doc.py]"]
end

subgraph group_support["Shared integration"]
  node_lims["iSkyLIMS API<br/>[drylab_api.py]"]
  node_utilities["Shared utilities<br/>[utils.py]"]
end

node_operator(("Bioinformatics operator"))
node_filesystem["Service storage"]
node_sftp["SFTP server"]

node_operator -->|"runs commands"| node_cli
node_cli -->|"dispatches"| node_list
node_cli -->|"dispatches"| node_create
node_cli -->|"dispatches"| node_scratch
node_cli -->|"dispatches"| node_cleanup
node_cli -->|"dispatches"| node_archive
node_cli -->|"dispatches"| node_sftp_copy
node_cli -->|"dispatches"| node_sftp_clean
node_cli -->|"dispatches"| node_docs
node_create -->|"copies templates"| node_templates
node_create -->|"looks up services"| node_service_catalog
node_create -->|"requests resolution data"| node_lims
node_scratch -->|"copies service folders"| node_filesystem
node_cleanup -->|"removes or renames"| node_filesystem
node_archive -->|"archives services"| node_filesystem
node_sftp_copy -->|"updates service status"| node_lims
node_sftp_copy -.->|"copies resolution"| node_sftp
node_sftp_clean -.->|"cleans old services"| node_sftp
node_docs -->|"requests service data"| node_lims
node_docs -->|"writes reports"| node_filesystem
node_list -->|"reads service list"| node_service_catalog
node_cli -->|"loads settings"| node_settings
node_create -->|"uses helpers"| node_utilities
node_scratch -->|"uses helpers"| node_utilities
node_cleanup -->|"uses helpers"| node_utilities
node_lims -.->|"authenticates requests"| node_operator

click node_cli "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/__main__.py"
click node_settings "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/config_json.py"
click node_service_catalog "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/service_json.py"
click node_list "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/list.py"
click node_create "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/new_service.py"
click node_templates "https://github.com/bu-isciii/buisciii-tools/tree/main/buisciii/templates"
click node_scratch "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/scratch.py"
click node_cleanup "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/clean.py"
click node_archive "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/archive.py"
click node_sftp_copy "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/copy_sftp.py"
click node_sftp_clean "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/autoclean_sftp.py"
click node_docs "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/bioinfo_doc.py"
click node_lims "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/drylab_api.py"
click node_utilities "https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/utils.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_settings,node_service_catalog,node_list toneBlue
class node_create,node_templates,node_scratch,node_cleanup,node_archive,node_filesystem toneAmber
class node_sftp_copy,node_sftp_clean,node_docs,node_sftp toneMint
class node_lims,node_utilities toneRose
class node_operator toneIndigo
```

## Components

### CLI and setup

- [Command dispatcher](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/__main__.py): `buisciii/__main__.py`
- [Runtime settings](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/config_json.py): `buisciii/config_json.py`
- [Service catalog](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/service_json.py): `buisciii/service_json.py`
- [List services](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/list.py): `buisciii/list.py`

### Service lifecycle

- [Create service](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/new_service.py): `buisciii/new_service.py`
- [Pipeline templates](https://github.com/bu-isciii/buisciii-tools/tree/main/buisciii/templates): `buisciii/templates`
- [Scratch staging](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/scratch.py): `buisciii/scratch.py`
- [Service cleanup](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/clean.py): `buisciii/clean.py`
- [Archive services](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/archive.py): `buisciii/archive.py`

### Documentation and delivery

- [SFTP delivery](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/copy_sftp.py): `buisciii/copy_sftp.py`
- [SFTP cleanup](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/autoclean_sftp.py): `buisciii/autoclean_sftp.py`
- [Service documentation](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/bioinfo_doc.py): `buisciii/bioinfo_doc.py`

### Shared integration

- [iSkyLIMS API](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/drylab_api.py): `buisciii/drylab_api.py`
- [Shared utilities](https://github.com/bu-isciii/buisciii-tools/blob/main/buisciii/utils.py): `buisciii/utils.py`

### Other components

- **Bioinformatics operator**
- **Service storage**
- **SFTP server**

## Connections

- Bioinformatics operator → Command dispatcher: runs commands (evidence: `README.md`)
- Command dispatcher → List services: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → Create service: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → Scratch staging: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → Service cleanup: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → Archive services: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → SFTP delivery: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → SFTP cleanup: dispatches (evidence: `buisciii/__main__.py`)
- Command dispatcher → Service documentation: dispatches (evidence: `buisciii/__main__.py`)
- Create service → Pipeline templates: copies templates (evidence: `buisciii/new_service.py`)
- Create service → Service catalog: looks up services (evidence: `buisciii/new_service.py`)
- Create service → iSkyLIMS API: requests resolution data (evidence: `buisciii/new_service.py`)
- Scratch staging → Service storage: copies service folders (evidence: `buisciii/scratch.py`)
- Service cleanup → Service storage: removes or renames (evidence: `buisciii/clean.py`)
- Archive services → Service storage: archives services (evidence: `buisciii/archive.py`)
- SFTP delivery → iSkyLIMS API: updates service status (evidence: `buisciii/copy_sftp.py`)
- SFTP delivery → SFTP server: copies resolution (evidence: `README.md`)
- SFTP cleanup → SFTP server: cleans old services (evidence: `README.md`)
- Service documentation → iSkyLIMS API: requests service data (evidence: `buisciii/bioinfo_doc.py`)
- Service documentation → Service storage: writes reports (evidence: `buisciii/bioinfo_doc.py`)
- List services → Service catalog: reads service list (evidence: `buisciii/list.py`)
- Command dispatcher → Runtime settings: loads settings (evidence: `buisciii/__main__.py`)
- Create service → Shared utilities: uses helpers (evidence: `buisciii/new_service.py`)
- Scratch staging → Shared utilities: uses helpers (evidence: `buisciii/scratch.py`)
- Service cleanup → Shared utilities: uses helpers (evidence: `buisciii/clean.py`)
- iSkyLIMS API → Bioinformatics operator: authenticates requests
