Deployed a22b513 with MkDocs version: 1.5.3

architecture/c4/level_2_container/01_app_with_relational_db.puml

@@ -0,0 +1,11 @@
+@startuml
+!include ./container/containers.puml
+
+title Container Diagram - Application with Relational Database
+
+appContainer()
+relationalDbContainer()
+
+Rel_R(app, relationalDb, "Reads from and writes to", "SQLAlchemy")
+
+@enduml

architecture/c4/level_2_container/02_app_sftp_file_transfer.puml

@@ -0,0 +1,13 @@
+@startuml
+!include ./container/containers.puml
+
+title Container Diagram - SFTP File Transfer Application
+
+appContainer()
+externalSftpContainer()
+s3BucketContainer()
+
+Rel_L(app, externalSftp, "Reads files from", "AsyncSSH")
+Rel_R(app, s3Bucket, "Transfers files to", "aiobotocore")
+
+@enduml

architecture/c4/level_2_container/container/containers.puml

@@ -0,0 +1,20 @@
+@startuml
+!include <C4/C4_Container>
+
+!procedure appContainer()
+    Container(app, "Application", "Python, tomodachi")
+!endprocedure
+
+!procedure relationalDbContainer()
+    ContainerDb(relationalDb, "Relational database", "PostgreSQL", "Datastore.")
+!endprocedure
+
+!procedure externalSftpContainer()
+    Container_Ext(externalSftp, "Client SFTP server", "SFTP", "Files provided by a client.")
+!endprocedure
+
+!procedure s3BucketContainer()
+    Container(s3Bucket, "S3 bucket", "AWS S3", "Internal file storage.")
+!endprocedure
+
+@enduml

architecture/c4/level_3_component/01_app_with_relational_db.puml

@@ -0,0 +1,43 @@
+@startuml
+!include <C4/C4_Component>
+!include ../level_2_container/container/containers.puml
+
+title Component Diagram - Application with Relational Database
+
+relationalDbContainer()
+
+Boundary(appContainerBoundary, "Application", "Container") {
+    Boundary(serviceLayer, "Service", "Layer") {
+        Component(useCases, "Use cases", "Python", "Application use cases (services).")
+    }
+
+    Boundary(domainLayer, "Domain", "Layer") {
+        Component(domain, "Domain", "Python", "Application domain objects.")
+
+        Component(ports, "Ports", "Python, typing.Protocol", "Ports protocol.")
+    }
+
+    Boundary(infrastructureLayer, "Adapters", "Layer") {
+        Component(Repository, "In-memory repository", "Python", "Fake in-memory repository for testing and demo purposes.")
+
+        Component_Ext(postgresRepository, "PostgreSQL repository", "Python, SQLAlchemy", "Adapter for PostgreSQL database.")
+    }
+}
+
+Component(testcontainers, "Testcontainers", "Python, pytest", "Testcontainers library.")
+
+Lay_R(domain, ports)
+
+Lay_R(Repository, postgresRepository)
+
+Rel_D(useCases, ports, "Uses")
+Rel_D(useCases, domain, "Uses")
+
+Rel_U(Repository, ports, "Implements")
+Rel_U(postgresRepository, ports, "Implements")
+
+Rel_D(postgresRepository, relationalDb, "Reads from and writes to", "SQLAlchemy")
+
+Rel_U(testcontainers, relationalDb, "Creates PostgreSQL testcontainer")
+
+@enduml

architecture/c4/level_3_component/02_app_sftp_file_transfer.puml

@@ -0,0 +1,50 @@
+@startuml
+!include <C4/C4_Component>
+!include ../level_2_container/container/containers.puml
+
+skinparam dpi 125
+
+title Component Diagram - SFTP File Transfer Application
+
+externalSftpContainer()
+s3BucketContainer()
+
+Boundary(appContainerBoundary, "Application", "Container") {
+    Boundary(serviceLayer, "Service", "Layer") {
+        Component(useCases, "Use cases", "Python", "Application use cases (services).")
+    }
+
+    Boundary(domainLayer, "Domain", "Layer") {
+        Component(domain, "Domain", "Python", "Application domain objects.")
+
+        Component(ports, "Ports", "Python, typing.Protocol", "Ports protocol.")
+    }
+
+    Boundary(infrastructureLayer, "Adapters", "Layer") {
+        Component_Ext(sftpClient, "SFTP client", "Python, AsyncSSH", "Adapter for SFTP file operations.")
+
+        Component_Ext(s3Client, "S3 client", "Python, aiobotocore", "Adapter for S3 file operations.")
+
+        Component(fakeSftpClient, "In-memory SFTP client", "Python", "Fake for testing and demo purposes.")
+
+        Component(fakeS3Client, "In-memory S3 client", "Python", "Fake for testing and demo purposes.")
+    }
+}
+
+Component(testcontainers, "Testcontainers", "Python, pytest", "Testcontainers library.")
+
+Rel_D(useCases, ports, "Uses")
+Rel_D(useCases, domain, "Uses")
+
+Rel_U(sftpClient, ports, "Implements")
+Rel_U(s3Client, ports, "Implements")
+Rel_U(fakeSftpClient, ports, "Implements")
+Rel_U(fakeS3Client, ports, "Implements")
+
+Rel_D(sftpClient, externalSftp, "Reads files from", "AshyncSSH")
+Rel_D(s3Client, s3Bucket, "Transfers files to ", "aiobotocore")
+
+Rel_U(testcontainers, externalSftp, "Creates SFTP testcontainer")
+Rel_U(testcontainers, s3Bucket, "Creates LocalStack testcontainer")
+
+@enduml

assets/_mkdocstrings.css

@@ -0,0 +1,64 @@
+
+/* Avoid breaking parameter names, etc. in table cells. */
+.doc-contents td code {
+  word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+  display: table !important;
+  width: 100%;
+}
+
+.doc .md-typeset__table tr {
+  display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-param-default {
+  float: right;
+}
+
+/* Keep headings consistent. */
+h1.doc-heading,
+h2.doc-heading,
+h3.doc-heading,
+h4.doc-heading,
+h5.doc-heading,
+h6.doc-heading {
+  font-weight: 400;
+  line-height: 1.5;
+  color: inherit;
+  text-transform: none;
+}
+
+h1.doc-heading {
+  font-size: 1.6rem;
+}
+
+h2.doc-heading {
+  font-size: 1.2rem;
+}
+
+h3.doc-heading {
+  font-size: 1.15rem;
+}
+
+h4.doc-heading {
+  font-size: 1.10rem;
+}
+
+h5.doc-heading {
+  font-size: 1.05rem;
+}
+
+h6.doc-heading {
+  font-size: 1rem;
+}