add pre-commit hooks

README.md

@@ -18,13 +18,15 @@ You can install pyasic directly from pip with the command `pip install pyasic`
 For those of you who aren't comfortable with code and developer tools, there are windows builds of GUI applications that use this library here -> (https://drive.google.com/drive/folders/1DjR8UOS_g0ehfiJcgmrV0FFoqFvE9akW?usp=sharing)
 
 ### Developers
-To use this repo, first download it, create a virtual environment, enter the virtual environment, and install relevant packages by navigating to this directory and running ```pip install -r requirements.txt``` on Windows or ```pip3 install -r requirements.txt``` on Mac or UNIX if the first command fails.
+To use this repo, first download it, create a virtual environment, enter the virtual environment, and install relevant packages by navigating to this directory and running ```pip install -r requirements-dev.txt``` on Windows or ```pip3 install -r requirements-dev.txt``` on Mac or UNIX if the first command fails.
 
-You can also use poetry by initializing and running ```poetry install```
+You can also use poetry by initializing and running ```poetry install```, and you will have to install `pre-commit` (`pip install pre-commit`).
+
+Finally, initialize pre-commit hooks with `pre-commit install`
 
 ### Interfacing with miners programmatically
 
-##### Note: If you are trying to interface with Whatsminers, there is a bug in the way they are interacted with on Windows, so to fix that you need to change the event loop policy using this code: 
+##### Note: If you are trying to interface with Whatsminers, there is a bug in the way they are interacted with on Windows, so to fix that you need to change the event loop policy using this code:
 ```python
 # need to import these 2 libraries, you need asyncio anyway so make sure you have sys imported
 import sys
@@ -66,18 +68,18 @@ async def scan_and_get_data():
     # Scan the network for miners
     # This function returns a list of miners of the correct type as a class
     miners: list = await net.scan_network_for_miners()
-    
+
     # We can now get data from any of these miners
     # To do them all we have to create a list of tasks and gather them
     tasks = [miner.get_data() for miner in miners]
     # Gather all tasks asynchronously and run them
     data = await asyncio.gather(*tasks)
-    
+
     # Data is now a list of MinerData, and we can reference any part of that
     # Print out all data for now
     for item in data:
         print(item)
-      
+
 if __name__ == "__main__":
     asyncio.run(scan_and_get_data())
 ```
@@ -102,7 +104,7 @@ async def get_miner_data(miner_ip: str):
     # Use MinerFactory to get miner
     # MinerFactory is a singleton, so we can just get the instance in place
     miner = await MinerFactory().get_miner(miner_ip)
-    
+
     # Get data from the miner
     data = await miner.get_data()
     print(data)
@@ -131,11 +133,11 @@ if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.starts
 async def get_api_commands(miner_ip: str):
     # Get the miner
     miner = await MinerFactory().get_miner(miner_ip)
-    
+
     # List all available commands
     print(miner.api.get_commands())
-    
-    
+
+
 if __name__ == "__main__":
     asyncio.run(get_api_commands("192.168.1.69"))
 ```
@@ -159,13 +161,13 @@ if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.starts
 async def get_api_commands(miner_ip: str):
     # Get the miner
     miner = await MinerFactory().get_miner(miner_ip)
-    
+
     # Run the devdetails command
     # This is equivalent to await miner.api.send_command("devdetails")
     devdetails: dict = await miner.api.devdetails()
     print(devdetails)
-    
-    
+
+
 if __name__ == "__main__":
     asyncio.run(get_api_commands("192.168.1.69"))
 ```