Merge pull request #5 from KrishnanSG/networking

Add documentation

Author: KrishnanSG

P2P/README.md P2P/MessageFormat.mdP2P/README.md renamed to P2P/MessageFormat.md

@@ -9,14 +9,12 @@ Each message will have this format
 
 ```
 
-Maybe pad all the messages with some delimiter bytes to seperate the different requests
-
 Once the BF is exchanged
 1. Call getMissingContent for both users
 2. Send the missing contents of user 1 to user 2
 3. Call merge function on user2 side
-4. Send entire file sha256 and check on both ends
+4. Send entire file hash value and check on both ends
     if equal
         done
     else
-        send the entire file
+        send the entire compressed file 

P2P/Server.py

@@ -59,4 +59,4 @@ def create_client(self,ip,port):
         host = socket.gethostname()
         client.connect((ip,port))
         client.setblocking(False)
-        print("\nHi ",host," you are succesfully connected to")
+        print("\nHi ",host," you are succesfully connected")

P2P/received_file

@@ -48,7 +48,6 @@ def parse_received_data(data):
         # Occurs sometimes when the contents received are not in utf-8
         # This can happen for example, when transmitting the hash value.
         str_message = bloom_filter
-    print(bytes.hex(type_specifying_byte))
     type_int = int(bytes.hex(type_specifying_byte), 16)
     req = Request(type_int, str_message)
     return req

P2P/utils.py

@@ -1,2 +1,74 @@
 # Interact
-Real time file synchronization using Bloom Filter and Splay Tree
+
+An easy to use real time file synchronization application built using Python.
+<img src="https://user-images.githubusercontent.com/43802499/68604424-71f7df00-04d0-11ea-9773-1d51344c8318.png" align="right"
+     title="File-Sync" width="220" height="250">
+
+## Getting Started
+
+These instructions will get you a copy of the project and ready for on your local machine.
+
+### Prerequisites
+  - Python 3.7
+
+  - Clone this repository using the command:
+
+    ```
+      git clone https://github.com/KrishnanSG/Interact.git
+      cd Interact
+    ```
+    
+  - Then install a few required dependencies by using your favorite terminal
+
+    ```
+      pip install -r requirements.txt
+    ```
+
+### How to Use
+
+You're almost there. 
+The following steps will guide you on how to use this tool.
+
+1. Creating host server
+    ```
+        python main.py <filename> --host
+    ```
+
+2. Ask your friend to connect to the server
+    ```
+        python main.py <filename>
+
+        Provide inputs for the prompt messages.
+    ```
+
+3. Enjoy the sync. We automatically detect for modification made in the file, so just save the file.
+
+## How does this work?
+
+Most the of the file synchronziers send the complete file across the network for every sync cycle.
+
+### How we do it?
+**BloomFilters**
+
+A Bloom filter is a space-efficient probabilistic data structure that is used to test whether an element is a member of a set. Check out this [link](https://www.geeksforgeeks.org/bloom-filters-introduction-and-python-implementation/) to know more.
+
+### The protocol
+We will be using a few terms in the due course of the explanation.
+- **Host** - the user who has intiated the P2P server.
+- **Client** - the user who connects to the host.
+- **User1** - the user who initates the sync cycle (would have made some modification to the file).
+- **User2** - the user whose file will get updated.
+- **getMissingContent()** - a function to find the missing contents.
+- **syncFile()** - a function to merge (reproduce the changes on the destination).
+
+![Sync-Protocol](https://user-images.githubusercontent.com/43802499/68604316-31986100-04d0-11ea-9f65-fce7b3cd8357.png)
+
+### Conclusion
+The algorithm developed does synchronization effieciently since the size of the BloomFiter transmitted is in **bits** while the file would be in **MBs**.
+
+The total average transmition cost was found out to be size_of_BloomFilter (Few btyes) + number of lines modified (a few 100 bytes).
+
+## Authors
+
+* **Krishnan S G** - [@KrishnanSG](https://github.com/KrishnanSG)
+* **Sivagiri Visakan** - [@SivagiriVisakan](https://github.com/SivagiriVisakan)

README.md

@@ -47,6 +47,5 @@ def computeHash(filename):
     # returns 4 byte hash value of the file
     file_reader = open(filename,"rb")
     file_contents = file_reader.read()
-    n=abs(mmh3.hash(file_contents)) % 2**32
-    return (n.to_bytes((n.bit_length()+7)//8,'big'))
-
+    n=abs(mmh3.hash(file_contents))
+    return (n.to_bytes((n.bit_length()+7)//8,'big'))