Skip to content

Commit

Permalink
package structure diagram for the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benne238 committed May 7, 2021
1 parent c41325c commit a8b8eae
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion docs/package-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit a8b8eae

Please sign in to comment.