Skip to content

Commit

Permalink
docs: add some public devnotes
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Mar 17, 2024
1 parent 911ca73 commit 6192cb4
Show file tree
Hide file tree
Showing 8 changed files with 493 additions and 0 deletions.
14 changes: 14 additions & 0 deletions devnotes/CI-CD_2024-03-17.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Continuous Integration and Continuous Deployment Diagram

```mermaid
graph LR
A[Push or Pull Request\nto main] --> B[Unit-Tests]
B --> C[Codecov]
B --> D[Continuous-Deployment]
D --> E[Publish-To-PyPi]
D --> F[Build-Docker-Images]
E --> G[Test-PyPi-Install]
F --> H[Test-Docker-Image]
A --> I[Build-Documentation]
```
4 changes: 4 additions & 0 deletions devnotes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Developer Notes

[CI-CD](CI-CD_2024-03-17.md)
[Sequence Diagram](Sequence-diagram_2024-03-17.md)
151 changes: 151 additions & 0 deletions devnotes/class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions devnotes/classes_nbiatoolkit.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
digraph "classes_nbiatoolkit" {
rankdir=BT
charset="utf-8"
"nbiatoolkit.nbia.NBIAClient" [color="#77AADD", fontcolor="black", label=<{NBIAClient|OAuth_client<br ALIGN="LEFT"/>base_url<br ALIGN="LEFT"/>headers<br ALIGN="LEFT"/>logger<br ALIGN="LEFT"/>return_type<br ALIGN="LEFT"/>|downloadSeries(SeriesInstanceUID: Union[str, list], downloadDir: str, filePattern: str, overwrite: bool, nParallel: int, Progressbar: bool): bool<br ALIGN="LEFT"/>getBodyPartCounts(Collection: str, Modality: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getCollectionDescriptions(collectionName: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getCollectionPatientCount(prefix: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getCollections(prefix: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getDICOMTags(SeriesInstanceUID: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getModalityValues(Collection: str, BodyPartExamined: str, Counts: bool, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getNewPatients(Collection: str, Date: Union[str, datetime], return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getNewSeries(Date: Union[str, datetime], return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getPatients(Collection: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getPatientsByCollectionAndModality(Collection: str, Modality: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getSeries(Collection: str, PatientID: str, StudyInstanceUID: str, Modality: str, SeriesInstanceUID: str, BodyPartExamined: str, ManufacturerModelName: str, Manufacturer: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getSeriesMetadata(SeriesInstanceUID: Union[str, list[str]], return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>getStudies(Collection: str, PatientID: str, StudyInstanceUID: str, return_type: Optional[Union[ReturnType, str]]): List[dict[Any, Any]] \| pd.DataFrame<br ALIGN="LEFT"/>parsePARAMS(params: dict): dict<br ALIGN="LEFT"/>query_api(endpoint: NBIA_ENDPOINTS, params: dict): List[dict[Any, Any]]<br ALIGN="LEFT"/>}>, shape="record", style="filled"];
"nbiatoolkit.utils.nbia_endpoints.NBIA_BASE_URLS" [color="#BBCC33", fontcolor="black", label=<{NBIA_BASE_URLS|name<br ALIGN="LEFT"/>|}>, shape="record", style="filled"];
"nbiatoolkit.auth.OAuth2" [color="#77AADD", fontcolor="black", label=<{OAuth2|access_token<br ALIGN="LEFT"/>api_headers<br ALIGN="LEFT"/>base_url : NBIA, str<br ALIGN="LEFT"/>client_id : str<br ALIGN="LEFT"/>expiry_time : NoneType<br ALIGN="LEFT"/>fernet_key<br ALIGN="LEFT"/>password : str<br ALIGN="LEFT"/>refresh_expiration_time<br ALIGN="LEFT"/>refresh_expiry : NoneType<br ALIGN="LEFT"/>refresh_token : str<br ALIGN="LEFT"/>scope : NoneType<br ALIGN="LEFT"/>token_expiration_time<br ALIGN="LEFT"/>token_scope<br ALIGN="LEFT"/>username : str<br ALIGN="LEFT"/>|is_logged_out(): bool<br ALIGN="LEFT"/>is_token_expired(): bool<br ALIGN="LEFT"/>logout(): None<br ALIGN="LEFT"/>refresh_token_or_request_new(): None<br ALIGN="LEFT"/>request_new_access_token()<br ALIGN="LEFT"/>set_token_data(token_data: dict)<br ALIGN="LEFT"/>}>, shape="record", style="filled"];
"nbiatoolkit.utils.nbia_endpoints.ReturnType" [color="#BBCC33", fontcolor="black", label=<{ReturnType|name<br ALIGN="LEFT"/>|}>, shape="record", style="filled"];
"nbiatoolkit.auth.OAuth2" -> "nbiatoolkit.nbia.NBIAClient" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="_oauth2_client", style="solid"];
"nbiatoolkit.utils.nbia_endpoints.NBIA_BASE_URLS" -> "nbiatoolkit.nbia.NBIAClient" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="_base_url", style="solid"];
"nbiatoolkit.utils.nbia_endpoints.ReturnType" -> "nbiatoolkit.nbia.NBIAClient" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="_return_type", style="solid"];
"nbiatoolkit.utils.nbia_endpoints.ReturnType" -> "nbiatoolkit.nbia.NBIAClient" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="_return_type", style="solid"];
}
Loading

0 comments on commit 6192cb4

Please sign in to comment.