From a8b8eae81fbbcff077e0ae99665eab09cf0e2d5c Mon Sep 17 00:00:00 2001
From: benne238 <benne238@purdue.edu>
Date: Fri, 7 May 2021 15:51:39 -0400
Subject: [PATCH] package structure diagram for the docs

---
 docs/package-structure.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/docs/package-structure.md b/docs/package-structure.md
index c88ff85..e2450bb 100644
--- a/docs/package-structure.md
+++ b/docs/package-structure.md
@@ -26,5 +26,38 @@ The initialization scripts take in user input (either via command line or wrappe
 ## Structure
 
 ```none
-
+webqueue2_api/  # webqueue2_api parent package
+│
+├── api/                # api subpackage
+│   ├── __init__.py
+│   ├── auth.py
+│   └── resources/
+│       ├── __init__.py
+│       ├── item.py
+│       ├── login.py
+│       ├── queue.py
+│       ├── queue_list.py
+│       └── refresh_access_token.py
+│
+├── ECNQueue/           # ecnqueue subpackge
+│   ├── __init__.py
+│   ├── Item.py
+│   ├── parser/
+│   │   ├── __init__.py
+│   │   └── parser.py
+│   ├── Queue.py
+│   └── utils.py
+│
+├── logger/             # logger subpackage
+│   └─── __init__.py
+│
+├── utils/              # utils subpackage
+│   ├── __init__.py
+│   └── tree.py
+│
+├── __init__.py
+├── __main__.py         # parses user input
+├── global_configs.py   # stores the config file location
+├── start.py            # returns a flask object ater initializing the user configs
+└── validate_arguments.py   # validates all of teh user passed arguments
 ```
\ No newline at end of file