feat: resolves #3

.github/workflows/docs.yaml

@@ -15,6 +15,6 @@ jobs:
         cache: 'pip'
     - name: Install dependencies
       run: |
-        pip install hatch pdocs mkdocs-material mkdocs-jupyter
+        pip install hatch pdocs mkdocs-material mkdocs-jupyter mkdocs-plantuml-local
         hatch build
         mkdocs gh-deploy --force

.gitignore

@@ -11,4 +11,8 @@ build
 *.whl
 *.zip
 env-calrissian*
-*.tar.gz
+*.tar.gz
+.project
+.pydevproject
+.cache
+site

docs/puml/class.md

@@ -0,0 +1,149 @@
+Calrissian class diagram
+
+```puml
+@startuml
+left to right direction
+!pragma useIntermediatePackages false
+
+class calrissian.context.CalrissianLoadingContext {
+}
+class calrissian.context.CalrissianRuntimeContext {
+  pod_labels: None
+  pod_env_vars: None
+  pod_nodeselectors: None
+  pod_serviceaccount: None
+  tool_logs_basepath: None
+  max_gpus: None
+}
+class calrissian.executor.DuplicateJobException {
+}
+class calrissian.executor.IncompleteStatusException {
+}
+class calrissian.executor.InconsistentResourcesException {
+}
+class calrissian.executor.JobResourceQueue {
+  jobs: None
+  priority: None
+  descending: None
+}
+class calrissian.executor.OversizedJobException {
+}
+class calrissian.executor.Resources {
+  ram: None
+  cores: None
+  gpus: None
+}
+class calrissian.executor.ThreadPoolJobExecutor {
+  max_workers: None
+  jrq: None
+  exceptions: None
+  total_resources: None
+  available_resources: None
+  resources_lock: None
+}
+class calrissian.job.CalrissianCommandLineJob {
+  client: None
+  volume_builder: None
+}
+class calrissian.job.CalrissianCommandLineJobException {
+}
+class calrissian.k8s.CompletionResult {
+  exit_code: None
+  cpus: None
+  memory: None
+  start_time: None
+  finish_time: None
+  tool_log: None
+}
+class calrissian.k8s.KubernetesClient {
+  pod: None
+  completion_result: None
+  namespace: None
+  core_api_instance: None
+  tool_log: None
+}
+class calrissian.job.KubernetesPodBuilder {
+  name: None
+  container_image: None
+  environment: None
+  volume_mounts: None
+  volumes: None
+  command_line: None
+  stdout: None
+  stderr: None
+  stdin: None
+  resources: None
+  labels: None
+  nodeselectors: None
+  security_context: None
+  serviceaccount: None
+  requirements: None
+  hints: None
+}
+class calrissian.job.KubernetesPodVolumeInspector {
+  pod: None
+}
+class calrissian.job.KubernetesVolumeBuilder {
+  persistent_volume_entries: None
+  emptydir_volume_names: None
+  volume_mounts: None
+  volumes: None
+}
+class calrissian.report.Reporter {
+}
+class calrissian.report.TimedResourceReport {
+  cpus: None
+  ram_megabytes: None
+  disk_megabytes: None
+  exit_code: None
+}
+class calrissian.job.VolumeBuilderException {
+}
+class calrissian.k8s.CalrissianJobException {
+}
+class calrissian.k8s.PodMonitor {
+}
+class calrissian.report.CPUParser {
+}
+class calrissian.report.MemoryParser {
+}
+class calrissian.report.Event {
+  time: None
+  type: None
+  report: None
+}
+class calrissian.report.MaxParallelCPUsProcessor {
+}
+class calrissian.report.MaxParallelCountProcessor {
+  count: None
+  max: None
+}
+class calrissian.report.MaxParallelRAMProcessor {
+}
+class calrissian.report.ResourceParser {
+}
+class calrissian.report.TimedReport {
+  name: None
+  start_time: None
+  finish_time: None
+}
+class calrissian.report.TimelineReport {
+  cores_allowed: None
+  ram_mb_allowed: None
+  children: None
+}
+class calrissian.retry.RetryParameters {
+}
+class calrissian.tool.CalrissianCommandLineTool {
+}
+class calrissian.tool.CalrissianCommandLineToolException {
+}
+calrissian.report.TimedReport <|-- calrissian.report.TimedResourceReport
+calrissian.report.ResourceParser <|-- calrissian.report.CPUParser
+calrissian.report.ResourceParser <|-- calrissian.report.MemoryParser
+calrissian.report.MaxParallelCountProcessor <|-- calrissian.report.MaxParallelCPUsProcessor
+calrissian.report.MaxParallelCountProcessor <|-- calrissian.report.MaxParallelRAMProcessor
+calrissian.report.TimedReport <|-- calrissian.report.TimelineReport
+footer Generated by //py2puml//
+@enduml
+```

mkdocs.yml

@@ -20,6 +20,17 @@ markdown_extensions:
 plugins:
 - search
 #- mkdocs-jupyter
+- plantuml-local:
+    shortname: puml
+    background_colour: transparent
+    class_name: plantuml-diagram
+    cache: true
+markdown_extensions:
+- pymdownx.superfences:
+    custom_fences:
+    - name: puml
+      class: puml
+      format: !!python/name:pymdownx.superfences.fence_code_format
 
 nav:
 - Introduction: 'index.md'
@@ -30,3 +41,5 @@ nav:
   - 1.1.0: 'conformance/1.1.0.md'
   - 1.2.0: 'conformance/1.2.0.md'
   - 1.2.1: 'conformance/1.2.1.md'
+- Development:
+  - Class diagram: 'puml/class.md'

requirements.txt

@@ -0,0 +1,13 @@
+cwltool==3.1.20220224085855
+freezegun==1.5.1
+kubernetes==31.0.0
+PyYAML==6.0.2
+PyYAML==5.4.1
+PyYAML==6.0.2
+schema_salad==8.5.20240503091721
+schema_salad==8.2.20220103095339
+setuptools==59.6.0
+shellescape==3.4.1
+tenacity==9.0.0
+typing_extensions==3.10.0.2
+urllib3==1.26.5