rename methods

Author: AndyEveritt

README.md

@@ -33,14 +33,14 @@ The REST API allows for the following operations:
 Method | Description
 ------ | -----------
 `get_model(key: str = None) -> Dict` | Get Duet object model. RRF3 only
-`post_code(code: str) -> Dict` | Send G/M/T-code to Duet
+`send_code(code: str) -> Dict` | Send G/M/T-code to Duet
 `get_file(filename: str, directory: str = 'gcodes') -> str` | Download file from Duet
-`put_file(file: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
+`upload_file(file: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
 `get_fileinfo(filename: str = None, directory: str = 'gcodes') -> Dict` | Get file info
 `delete_file(filename: str, directory: str = 'gcodes') -> Dict` | Delete file on Duet
 `move_file(from_path: str, to_path: str, force: bool = False) -> Dict` | Move file on Duet, can be used to rename files
 `get_directory(directory: str) -> List[Dict]` | Get a list of all the files & directories in a directory
-`put_directory(directory: str) -> Dict` | Create a new directory
+`create_directory(directory: str) -> Dict` | Create a new directory
 
 
 ## Wrapper

duetwebapi/api/base.py

@@ -14,15 +14,15 @@ def get_model(self, key: str = None) -> Dict:
         """ Get Duet object model. RRF3 only """
         raise NotImplementedError
 
-    def post_code(self, code: str) -> Dict:
+    def send_code(self, code: str) -> Dict:
         """ Send G/M/T-code to Duet """
         raise NotImplementedError
 
     def get_file(self, filename: str, directory: str = 'gcodes') -> str:
         """ Get file from Duet """
         raise NotImplementedError
 
-    def put_file(self, file: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
         """ Upload file to Duet """
         raise NotImplementedError
 
@@ -42,6 +42,6 @@ def get_directory(self, directory: str) -> List[Dict]:
         """ Get a list of all the files & directories in a directory """
         raise NotImplementedError
 
-    def put_directory(self, directory: str) -> Dict:
+    def create_directory(self, directory: str) -> Dict:
         """ Create a new directory """
         raise NotImplementedError

duetwebapi/api/dsf_api.py

@@ -22,7 +22,7 @@ def get_model(self, **_ignored) -> Dict:
         j = r.json()
         return j
 
-    def post_code(self, code: str) -> Dict:
+    def send_code(self, code: str) -> Dict:
         url = f'{self._base_url}/machine/code'
         r = requests.post(url, data=code)
         return {'response': r.text}
@@ -40,7 +40,7 @@ def get_file(self, filename: str, directory: str = 'gcodes') -> str:
             raise ValueError
         return r.text
 
-    def put_file(self, file: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
         """
         file: the path to the file you want to upload from your PC
         directory: the folder that the file is in, options are ['gcodes', 'macros', 'sys']
@@ -84,7 +84,7 @@ def get_directory(self, directory: str) -> List[Dict]:
             raise ValueError
         return r.json()
 
-    def put_directory(self, directory: str) -> Dict:
+    def create_directory(self, directory: str) -> Dict:
         url = f'{self._base_url}/machine/directory/{directory}'
         r = requests.put(url)
         if not r.ok:

duetwebapi/api/dwc_api.py

@@ -24,7 +24,7 @@ def get_model(self, key: str = None) -> Dict:
         j = r.json()
         return j['result']
 
-    def post_code(self, code: str) -> Dict:
+    def send_code(self, code: str) -> Dict:
         url = f'{self._base_url}/rr_gcode'
         r = requests.get(url, {'gcode': code})
         if not r.ok:
@@ -44,7 +44,7 @@ def get_file(self, filename: str, directory: str = 'gcodes') -> str:
             raise ValueError
         return r.text
 
-    def put_file(self, file: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
         file = os.path.abspath(file).replace('\\', '/')
         filename = file.split('/')[-1]
         url = f'{self._base_url}/rr_upload?name=/{directory}/{filename}'
@@ -87,7 +87,7 @@ def get_directory(self, directory: str) -> List[Dict]:
             raise ValueError
         return r.json()['files']
 
-    def put_directory(self, directory: str) -> Dict:
+    def create_directory(self, directory: str) -> Dict:
         url = f'{self._base_url}/rr_mkdir'
         r = requests.get(url, {'dir': f'/{directory}'})
         if not r.ok:

examples.py

@@ -14,11 +14,11 @@
 riley.get_model()
 bruce.get_model()
 
-riley.post_code('M115')
-bruce.post_code('M115')
+riley.send_code('M115')
+bruce.send_code('M115')
 
-riley.put_file('test.gcode')
-bruce.put_file('test.gcode')
+riley.upload_file('test.gcode')
+bruce.upload_file('test.gcode')
 
 riley.get_file('test.gcode')
 bruce.get_file('test.gcode')