Files.com 1.4.204__tar.gz → 1.4.206__tar.gz

{Files.com-1.4.204 → Files.com-1.4.206}/Files.com.egg-info/PKG-INFO

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

{Files.com-1.4.204 → Files.com-1.4.206}/PKG-INFO

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

{Files.com-1.4.204 → Files.com-1.4.206}/README.md

@@ -55,10 +55,17 @@ access to the entire API. If the user is not an administrator, you will only be
 that user can access, and no access will be granted to site administration functions in the API.
 
 ```python title="Example Request"
+import files_sdk
+
 files_sdk.set_api_key("YOUR_API_KEY")
 
 ## Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
-files_sdk.user.list(params, {"api_key": "YOUR_API_KEY"})
+try:
+  files_sdk.user.list(params, {"api_key": "YOUR_API_KEY"})
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
@@ -83,7 +90,14 @@ password.
 This returns a session object that can be used to authenticate SDK method calls.
 
 ```python title="Example Request"
-session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
+import files_sdk
+
+try:
+  session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 #### Using a Session
@@ -91,14 +105,21 @@ session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
 Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
 
 ```python title="Example Request"
+import files_sdk
+
 ## You may set the returned session to be used by default for subsequent requests.
 files_sdk.set_session(session)
 
-## Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
-user = files_sdk.user.User(params, {"session_id": session.id})
+try:
+  # Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+  user = files_sdk.user.User(params, {"session_id": session.id})
 
-## You may also specify the session ID on a per-request basis in the final parameter to static methods.
-files_sdk.user.find(id, params, {"session_id": session.id})
+  # You may also specify the session ID on a per-request basis in the final parameter to static methods.
+  files_sdk.user.find(id, params, {"session_id": session.id})
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 #### Logging Out
@@ -111,7 +132,7 @@ session.destroy()
 
 ## Configuration
 
-Global configuration is performed by setting atttributes on the `files_sdk` object.
+Global configuration is performed by setting attributes on the `files_sdk` object.
 
 ### Configuration Options
 
@@ -121,6 +142,8 @@ Setting the base URL for the API is required if your site is configured to disab
 This can also be set to use a mock server in development or CI.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.base_url = "https://SUBDOMAIN.files.com"
 ```
 
@@ -132,6 +155,7 @@ object in the standard manner as shown below:
 
 ```python title="Example setting"
 import logging
+
 logging.getLogger("files_sdk")
 ```
 
@@ -146,6 +170,8 @@ Allowed values are:
 * "debug"
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.console_log_level = "info"
 ```
 
@@ -154,6 +180,8 @@ files_sdk.console_log_level = "info"
 Open timeout in seconds. The default value is 30.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.open_timeout = 60
 ```
 
@@ -162,6 +190,8 @@ files_sdk.open_timeout = 60
 Read timeout in seconds. The default value is 60.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.read_timeout = 90
 ```
 
@@ -170,6 +200,8 @@ files_sdk.read_timeout = 90
 Initial retry delay in seconds. The default value is 0.5.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.initial_network_retry_delay = 1
 ```
 
@@ -178,6 +210,8 @@ files_sdk.initial_network_retry_delay = 1
 Maximum network retry delay in seconds. The default value is 2.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.max_network_retry_delay = 5
 ```
 
@@ -186,6 +220,8 @@ files_sdk.max_network_retry_delay = 5
 Maximum number of retries. The default value is 3.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.max_network_retries = 5
 ```
 
@@ -194,6 +230,8 @@ files_sdk.max_network_retries = 5
 Configure the local IP address from which to send requests.
 
 ```python title="Example setting"
+import files_sdk
+
 files_sdk.source_ip = '10.1.2.3'
 ```
 
@@ -213,13 +251,19 @@ The argument value is a Python dictionary that has a key of the resource field n
 value of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```python title="Sort Example"
-## users sorted by username
-files_sdk.set_api_key("my-key")
-users = files_sdk.user.list({
-  "sort_by": { "username": "asc"}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+import files_sdk
+
+try:
+  # users sorted by username
+  users = files_sdk.user.list({
+    "sort_by": { "username": "asc" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ### Filtering
@@ -246,45 +290,69 @@ filter on and a passed in value to use in the filter comparison.
 | `filter_lteq` | Range | Find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE). |
 
 ```python title="Exact Filter Example"
-## non admin users
-files_sdk.set_api_key("my-key")
-users = files_sdk.user.list({
-  "filter": { "not_site_admin": true}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+import files_sdk
+
+try:
+  # non admin users
+  users = files_sdk.user.list({
+    "filter": { "not_site_admin": true }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Range Filter Example"
-## users who haven't logged in since 2024-01-01
-files_sdk.set_api_key("my-key")
-users = files_sdk.user.list({
-  "filter_gteq": { "last_login_at": "2024-01-01" }
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+import files_sdk
+
+try:
+  # users who haven't logged in since 2024-01-01
+  users = files_sdk.user.list({
+    "filter_gteq": { "last_login_at": "2024-01-01" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Pattern Filter Example"
-## users whose usernames start with 'test'
-files_sdk.set_api_key("my-key")
-users = files_sdk.user.list({
-  "filter_prefix": { "username": "test" }
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+import files_sdk
+
+try:
+  # users whose usernames start with 'test'
+  users = files_sdk.user.list({
+    "filter_prefix": { "username": "test" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Combination Filter with Sort Example"
-## users whose usernames start with 'test' and are not admins
-files_sdk.set_api_key("my-key")
-users = files_sdk.user.list({
-  "filter_prefix": { "username": "test" },
-  "filter": { "not_site_admin": "true" },
-  "sort_by": { "username": "asc"}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+import files_sdk
+
+try:
+  # users whose usernames start with 'test' and are not admins
+  users = files_sdk.user.list({
+    "filter_prefix": { "username": "test" },
+    "filter": { "not_site_admin": "true" },
+    "sort_by": { "username": "asc" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ## Errors
@@ -304,12 +372,14 @@ Use standard Python exception handling to detect and deal with errors.  It is ge
 handle the general `files_sdk.error.Error` exception as a catch-all.
 
 ```python title="Example Error Handling"
+import files_sdk
+
 try:
   session = files_sdk.session.create({ "username": "USERNAME", "password": "BADPASSWORD" })
 except files_sdk.error.NotAuthenticatedError as err:
-    print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
 except files_sdk.error.Error as err:
-    print(f"Unknown Error Occurred ({type(err).__name__}):", err)
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ### Error Types
@@ -525,6 +595,8 @@ when handling errors related to duplicate file names and when developing tools f
 synchronization.
 
 ```python title="Compare Case-Insensitive Files and Paths"
+import files_sdk
+
 if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
     print("Paths are the same")
 ```

{Files.com-1.4.204 → Files.com-1.4.206}/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.204"
+version = "1.4.206"
 
 __version__ = version