From cb2809eb780ee36ff810e44863bbda67dc9b9b62 Mon Sep 17 00:00:00 2001
From: jo2-holdsworth <jack2.holdsworth@live.uwe.ac.uk>
Date: Wed, 5 Apr 2023 15:33:48 +0100
Subject: [PATCH] boilerplate

---
 README.md     | 9 ++++++---
 binaryheap.py | 8 ++++++++
 convert.py    | 7 +++++++
 hamradio.py   | 7 ++++++-
 hamserver.py  | 7 +++++++
 morse.py      | 7 +++++++
 runtime.py    | 7 +++++++
 server.py     | 7 +++++++
 unititest.py  | 7 +++++++
 9 files changed, 62 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 47c3b25..719592f 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,12 @@
   - [License](#license)
 
 ## Description
-
-Morse code :: Worksheet(2 part 2)\
-This is a rep for only worksheet 2 part 2. Worksheet 2 part 1 can be found here [IOT - Worksheet 2 part 1](https://gitlab.uwe.ac.uk/jo2-holdsworth/iot-worksheet-2-part-1)
+Worksheet(2 part 2)  
+-This worksheet explores using servers on the csct cloud and communicating via ham standards  
+**This is a rep for only worksheet 2 part 2.**
+* [IOT - Worksheet 2 part 1 ](https://gitlab.uwe.ac.uk/jo2-holdsworth/iot-worksheet-2-part-1) can be found here  
+* [IOT - Worksheet 2 part 2 ](https://gitlab.uwe.ac.uk/jo2-holdsworth/iot-worksheet-2-part-2)  **you are here**
+* [IOT - Worksheet 3](https://gitlab.uwe.ac.uk/jo2-holdsworth/iot-worksheet-3) can be found here
 
 
 ### Task 1: Binary heap.
diff --git a/binaryheap.py b/binaryheap.py
index 1eb3b6e..03838ca 100644
--- a/binaryheap.py
+++ b/binaryheap.py
@@ -1,3 +1,11 @@
+# ==============
+# File: binaryheap.py
+# By: Jack Holdsworth - 20023933
+# Use: binary heap decoder
+# Written on: Python 3.8
+# ==============
+
+
 def decode_bt(string):
     # a binary heap decode function without the use of OOP
 
diff --git a/convert.py b/convert.py
index 6542bc0..8617873 100644
--- a/convert.py
+++ b/convert.py
@@ -1,3 +1,10 @@
+# ==============
+# File: convert.py
+# By: Jack Holdsworth - 20023933
+# Use: As simple program to replace items in a string
+# Written on: Python 3.8
+# ==============
+
 tree = "-ETIANMSURWDKGOHVF*L*PJBXCYZQ**54*3*¿?2&*+****16=/***(*7***8*90*************_****\"**.********'**-********;!*)***¡*,****:****************$***********************************************************************************************************************"
 output = ""
 for item in tree:
diff --git a/hamradio.py b/hamradio.py
index 133cf0c..0472534 100644
--- a/hamradio.py
+++ b/hamradio.py
@@ -1,4 +1,9 @@
-# encode_ham(sender: str, receiver: str, msg:str) -> str
+# ==============
+# File: hamradio.py
+# By: Jack Holdsworth - 20023933
+# Use: Task 2, a program to have ham radio conversations via morse
+# Written on: Python 3.8
+# ==============
 import morse
 
 
diff --git a/hamserver.py b/hamserver.py
index 6b4118c..8a1d534 100644
--- a/hamserver.py
+++ b/hamserver.py
@@ -1,3 +1,10 @@
+# ==============
+# File: hamserver.py
+# By: Jack Holdsworth - 20023933
+# Use: Task 3, have ham morse conversations via the server
+# Written on: Python 3.8
+# ==============
+
 import server
 import asyncio
 import hamradio
diff --git a/morse.py b/morse.py
index bcc2529..1bde814 100644
--- a/morse.py
+++ b/morse.py
@@ -1,3 +1,10 @@
+# ==============
+# File: morse.py
+# By: Jack Holdsworth - 20023933
+# Use: A copy of morse from worksheet 2 part 1
+# Written on: Python 3.8
+# ==============
+
 class node:
     def __init__(self, value, left=None, right=None):
         self.value = value # Contains itself value
diff --git a/runtime.py b/runtime.py
index b66993e..3e26849 100644
--- a/runtime.py
+++ b/runtime.py
@@ -1,3 +1,10 @@
+# ==============
+# File: runtime.py
+# By: Jack Holdsworth - 20023933
+# Use: A simple program to test the run time of binaryheap
+# Written on: Python 3.8
+# ==============
+
 import time
 import binaryheap as morse
 start = time.time()
diff --git a/server.py b/server.py
index 4417835..cd0354e 100644
--- a/server.py
+++ b/server.py
@@ -1,3 +1,10 @@
+# ==============
+# File: server.py
+# By: Jack Holdsworth - 20023933
+# Use: Task 3, a program to communicate with the server
+# Written on: Python 3.8
+# ==============
+
 import asyncio
 import websockets
 import json
diff --git a/unititest.py b/unititest.py
index 668af82..e27c8ec 100644
--- a/unititest.py
+++ b/unititest.py
@@ -1,3 +1,10 @@
+# ==============
+# File: unittest.py
+# By: Jack Holdsworth - 20023933
+# Use: A simple unittest file for worksheet2 part 2
+# Written on: Python 3.8
+# ==============
+
 import unittest
 import binaryheap
 import hamradio
-- 
GitLab