Files.com 1.4.184__tar.gz → 1.4.185__tar.gz

{Files.com-1.4.184 → Files.com-1.4.185}/Files.com.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.184
+Version: 1.4.185
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.184 → Files.com-1.4.185}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.184
+Version: 1.4.185
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.184 → Files.com-1.4.185}/README.md

@@ -508,116 +508,117 @@ files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthori
 |`TrialLockedError`|  `SiteConfigurationError` |
 |`UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
-## Mock Server
-
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
-SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
-
-Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
-
-The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
-
-A README is available on the GitHub link.
-
-## File/Folder Operations
-
-This SDK allows both file-based transfer and data-based transfer. Please see the examples below.
+## Examples
 
 ### Upload
 
-The second parameter is optional and will simply use the local filename by default.
+#### Upload a File
 
 ```python
-files_sdk.file.upload_file("local.txt", "/remote.txt")
+files_sdk.file.upload_file("local.txt", "remote.txt")
 ```
 
 If the parent directories do not already exist, they can be automatically created by passing
 `mkdir_parents` in the `params`.
 
 ```python
-files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
+files_sdk.file.upload_file("local.txt", "uploads/remote.txt", params={"mkdir_parents": True})
 ```
 
-#### Writing a File Example (string)
+#### Write File Data
 
 ```python
 with files_sdk.file.open("foo.txt", 'w') as f:
     f.write("contents")
 ```
 
-#### Writing a File Example (binary)
+Or, for binary data:
 
 ```python
 with files_sdk.file.open("foo.txt", 'wb') as f:
     f.write(b"contents")
 ```
 
-### Download
+#### Create a Folder
+
+```python
+files_sdk.folder.create("path/to/folder/to/be/created", params={"mkdir_parents": True})
+```
 
-#### File Download
+### Download
 
-The second parameter is optional and will simply use the remote filename by default.
+#### Download a File
 
 ```python
-files_sdk.file.download_file("/remote.txt", "local.txt")
+files_sdk.file.download_file("remote.txt", "local.txt")
 ```
 
-#### Reading a File Example (string)
+#### Read File Data
 
 ```python
-with files_sdk.open("foo.txt", 'r') as f:
+with files_sdk.file.open("foo.txt", 'r') as f:
     print(f.read())
 ```
 
-#### Reading a File Example (binary)
+Or, for binary data:
 
 ```python
-with files_sdk.open("foo.txt", 'rb') as f:
+with files_sdk.file.open("foo.txt", 'rb') as f:
     print(f.read())
 ```
 
 ### List
 
+#### List Folder Contents
+
+There are two ways to list folder contents:
+1. `auto_paging_iter` - automatically paginates and loads each page into memory
+2. `load_next_page/has_next_page` - manually paginates and loads each page into memory
+
 ```python
-for f in files_sdk.folder.list_for("/").auto_paging_iter():
-    print(f.type, f.path)
+for item in files_sdk.folder.list_for("remote/path/to/folder/").auto_paging_iter():
+    print(item.type, item.path)
 ```
 
-#### List Responses and Cursor Paging
+```python
+list_obj = files_sdk.folder.list_for('remote/path/to/folder/')
+
+while True:
+    for item in list_obj:
+        print(item.type, item.path)
+    if not list_obj.has_next_page:
+        break
+    list_obj.load_next_page()
+```
 
-List responses for APIs with cursor support will return an iterable object
-which contains a single page of records. It has a built-in `auto_paging_iter`
-method to iterate through the pages, making the additional API calls
-as needed.
+### Copy
 
-##### Iterating with auto_paging_iter
+The copy method works for both files and folders.
 
 ```python
-list_obj = files_sdk.folder.list_for('/')
+files_sdk.file.copy("source/path", params={"destination": "destination/path"})
+```
+
+### Move
 
-for f in list_obj.auto_paging_iter():
-    print(f.type, f.path)
+The move method works for both files and folders.
+
+```python
+files_sdk.file.move("source/path", params={"destination": "destination/path"})
 ```
 
-##### Iterating Manually
+### Delete
+
+The delete method works for both files and folders.
 
 ```python
-list_obj = files_sdk.folder.list_for('/')
+files_sdk.file.delete("path/to/file/or/folder")
+```
 
-for f in list_obj:
-    print(f.type, f.path)
+In case the folder is not empty, you can use the `recursive` argument:
 
-while list_obj.has_next_page:
-    list_obj.load_next_page()
-    for f in list_obj:
-        print(f.type, f.path)
+```python
+files_sdk.file.delete("path/to/folder", params={"recursive": True})
 ```
 
 ### Comparing Case-Insensitive Files and Paths
@@ -628,3 +629,21 @@ For related documentation see [Case Sensitivity Documentation](https://www.files
 if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
     print("Paths are the same")
 ```
+
+## Mock Server
+
+Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+SDKs and other direct integrations against the Files.com API in an integration test environment.
+
+It is a Ruby app that operates as a minimal server for the purpose of testing basic network
+operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
+deeply inspect your submissions for correctness.
+
+Eventually we will add more features intended for integration testing, such as the ability to
+intentionally provoke errors.
+
+Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+
+The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
+
+A README is available on the GitHub link.

{Files.com-1.4.184 → Files.com-1.4.185}/files_sdk/__init__.py

@@ -208,7 +208,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.4.184"
+version = "1.4.185"
 
 __version__ = version