Skip to content

Commit 0a62490

Browse files
saimonationsaimonation
authored
Saimon/discalimer change log (#301)
1 parent bdfd2f2 commit 0a62490

5 files changed

Lines changed: 305 additions & 201 deletions

File tree

‎README.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,19 @@ root directory.
7878
.. code-block:: console
7979
8080
$ tox
81+
82+
Compatibility Notice
83+
====================
84+
85+
Future versions of the CTERA Python SDK may introduce breaking changes.
86+
A breaking change is any modification insupported functionality between released versions that may require
87+
users to update existing integrations or configurations to upgrade successfully.
88+
While efforts are made to minimize disruption, such changes are sometimes necessary to maintain and improve the software.
89+
90+
Notice of breaking changes will be detailed in the CTERA Python SDK changelog.
91+
Users are responsible for reviewing the changelog for each new version and thoroughly
92+
testing the software before deploying it in production.
93+
94+
By using the CTERA Python SDK, users acknowledge and agree that the SDK and its
95+
contributors are not liable for any damages, losses, or issues arising from the use or upgrade of the software,
96+
including those resulting from breaking changes.

‎docs/source/UserGuides/Miscellaneous/Auditing.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Auditing
2+
========
3+
4+
The SDK includes a module for recording all HTTP requests and exporting them as a Postman collection.
5+
For more information, see:
6+
`Import data into Postman <https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data/>`_
7+
By default, auditing is disabled for performance reasons. If you need to enable Postman auditing, use the following commands:
8+
9+
10+
.. code-block:: python
11+
12+
import cterasdk.settings
13+
cterasdk.settings.audit.enabled = True
14+
cterasdk.settings.audit.filename = 'name-of-your-postman-collection-file'
15+
16+
admin = GlobalAdmin('tenant.ctera.com')
17+
18+
.. note:: The Postman collection file is stored in your default Downloads directory.

‎docs/source/UserGuides/Miscellaneous/Changelog.rst‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
Changelog
2+
=========
3+
4+
2.20.11
5+
-------
6+
7+
Improvements
8+
^^^^^^^^^^^^
9+
10+
* Added a compatibility notice.
11+
* Included the changelog in the CTERA Python SDK documentation.
12+
13+
*Related issues and pull requests on GitHub:* `#301 <https://github.com/ctera/ctera-python-sdk/pull/301>`_
14+
15+
2.20.10
16+
-------
17+
18+
Improvements
19+
^^^^^^^^^^^^
20+
21+
* Revamped the exception modules in ``cterasdk.exceptions``.
22+
* Added support for file-walk operations without specifying a path (defaults to the root directory).
23+
* Implemented automatic file rename during upload if the destination path includes a file name that already exists.
24+
25+
*Related issues and pull requests on GitHub:* `#300 <https://github.com/ctera/ctera-python-sdk/pull/300>`_
26+
27+
2.20.9
28+
------
29+
30+
Improvements
31+
^^^^^^^^^^^^
32+
33+
* Introduced new exceptions for HTTP errors.
34+
* Added support for listing and walking directories via WebDAV on the Edge Filer using ``AsyncEdge`` and ``Edge`` clients.
35+
* Added a method to check if a file or folder exists.
36+
37+
*Related issues and pull requests on GitHub:* `#299 <https://github.com/ctera/ctera-python-sdk/pull/299>`_
38+
39+
40+
2.20.8
41+
------
42+
43+
What's New
44+
^^^^^^^^^^
45+
46+
* Added compatibility for CTERA Direct IO with CTERA Portal v8.3.
47+
48+
*Related issues and pull requests on GitHub:* `#298 <https://github.com/ctera/ctera-python-sdk/pull/298>`_
49+
50+
51+
2.20.7
52+
------
53+
54+
Improvements
55+
^^^^^^^^^^^^
56+
57+
* Updated :py:class:`cterasdk.common.object.Object` to inherit from ``MutableMapping``, enabling dictionary-like access.
58+
* Added support for the HTTP PROPFIND method.
59+
60+
*Related issues and pull requests on GitHub:* `#297 <https://github.com/ctera/ctera-python-sdk/pull/297>`_
61+
62+
63+
2.20.6
64+
------
65+
66+
Bug Fixes
67+
^^^^^^^^^
68+
69+
* Added support for deleting multiple files on the Edge Filer in a single call.
70+
71+
*Related issues and pull requests on GitHub:* `#296 <https://github.com/ctera/ctera-python-sdk/pull/296>`_
72+
73+
74+
2.20.5
75+
------
76+
77+
Bug Fixes
78+
^^^^^^^^^
79+
80+
* Fixed an issue where ``AsyncGlobalAdmin`` could not browse Team Portal tenants.
81+
82+
83+
2.20.4
84+
------
85+
86+
Bug Fixes
87+
^^^^^^^^^
88+
89+
* Moved instantiation of the TCP connector to the point of ``ClientSession`` creation.
90+
91+
*Related issues and pull requests on GitHub:* `#295 <https://github.com/ctera/ctera-python-sdk/pull/295>`_
92+
93+
94+
2.20.3
95+
------
96+
97+
What's New
98+
^^^^^^^^^^
99+
100+
* This version introduces a new ``AsyncEdge`` object for asynchronous access to the CTERA Edge Filer.
101+
* Supported file browser operations include:
102+
``listdir``, ``handle``, ``handle_many``, ``download``, ``download_many``,
103+
``upload``, ``upload_file``, ``mkdir``, ``makedirs``, ``copy``, ``move``, and ``delete``.
104+
105+
Improvements
106+
^^^^^^^^^^^^
107+
108+
* Logging is no longer enabled by default. As of this version, it is the responsibility of the
109+
client application to configure logging explicitly.
110+
This change aligns with best practices for libraries and allows greater flexibility in how logs are managed.
111+
112+
* Introduced improved configuration settings to support both synchronous and asynchronous access to the CTERA Portal and Edge Filers.
113+
114+
.. code-block:: python
115+
116+
# Disable TLS verification for CTERA Portal clients
117+
cterasdk.settings.core.syn.settings.connector.ssl = False # GlobalAdmin, ServicesPortal
118+
cterasdk.settings.core.asyn.settings.connector.ssl = False # AsyncGlobalAdmin, AsyncServicesPortal
119+
120+
# Disable TLS verification for CTERA Edge Filer clients
121+
cterasdk.settings.edge.syn.settings.connector.ssl = False # Edge
122+
cterasdk.settings.edge.asyn.settings.connector.ssl = False # AsyncEdge
123+
124+
*Related issues and pull requests on GitHub:* `#294 <https://github.com/ctera/ctera-python-sdk/pull/294>`_
125+

‎docs/source/UserGuides/Miscellaneous/Exceptions.rst‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
Exceptions
2+
==========
3+
4+
.. autoclass:: cterasdk.exceptions.CTERAException
5+
:noindex:
6+
:members:
7+
:show-inheritance:
8+
9+
.. autoclass:: cterasdk.exceptions.ObjectNotFoundException
10+
:noindex:
11+
:members:
12+
:show-inheritance:
13+
14+
.. autoclass:: cterasdk.exceptions.InputError
15+
:noindex:
16+
:members:
17+
:show-inheritance:
18+
19+
Session
20+
-------
21+
22+
.. autoclass:: cterasdk.exceptions.session.NotLoggedIn
23+
:noindex:
24+
:members:
25+
:show-inheritance:
26+
27+
.. autoclass:: cterasdk.exceptions.session.SessionExpired
28+
:noindex:
29+
:members:
30+
:show-inheritance:
31+
32+
.. autoclass:: cterasdk.exceptions.session.ContextError
33+
:noindex:
34+
:members:
35+
:show-inheritance:
36+
37+
I/O
38+
---
39+
40+
.. autoclass:: cterasdk.exceptions.io.RemoteStorageException
41+
:noindex:
42+
:members:
43+
:show-inheritance:
44+
45+
.. autoclass:: cterasdk.exceptions.io.ResourceNotFoundError
46+
:noindex:
47+
:members:
48+
:show-inheritance:
49+
50+
.. autoclass:: cterasdk.exceptions.io.NotADirectory
51+
:noindex:
52+
:members:
53+
:show-inheritance:
54+
55+
.. autoclass:: cterasdk.exceptions.io.ResourceExistsError
56+
:noindex:
57+
:members:
58+
:show-inheritance:
59+
60+
.. autoclass:: cterasdk.exceptions.io.PathValidationError
61+
:noindex:
62+
:members:
63+
:show-inheritance:
64+
65+
.. autoclass:: cterasdk.exceptions.io.NameSyntaxError
66+
:noindex:
67+
:members:
68+
:show-inheritance:
69+
70+
.. autoclass:: cterasdk.exceptions.io.ReservedNameError
71+
:noindex:
72+
:members:
73+
:show-inheritance:
74+
75+
.. autoclass:: cterasdk.exceptions.io.RestrictedPathError
76+
:noindex:
77+
:members:
78+
:show-inheritance:
79+
80+
Notification Service
81+
--------------------
82+
83+
.. autoclass:: cterasdk.exceptions.notifications.NotificationsError
84+
:noindex:
85+
:members:
86+
:show-inheritance:
87+
88+
89+
HTTP Transport
90+
--------------
91+
92+
.. autoclass:: cterasdk.exceptions.transport.HTTPError
93+
:noindex:
94+
:members:
95+
:show-inheritance:
96+
97+
.. autoclass:: cterasdk.exceptions.transport.BadRequest
98+
:noindex:
99+
:members:
100+
:show-inheritance:
101+
102+
.. autoclass:: cterasdk.exceptions.transport.Unauthorized
103+
:noindex:
104+
:members:
105+
:show-inheritance:
106+
107+
.. autoclass:: cterasdk.exceptions.transport.Forbidden
108+
:noindex:
109+
:members:
110+
:show-inheritance:
111+
112+
.. autoclass:: cterasdk.exceptions.transport.NotFound
113+
:noindex:
114+
:members:
115+
:show-inheritance:
116+
117+
.. autoclass:: cterasdk.exceptions.transport.Unprocessable
118+
:noindex:
119+
:members:
120+
:show-inheritance:
121+
122+
.. autoclass:: cterasdk.exceptions.transport.InternalServerError
123+
:noindex:
124+
:members:
125+
:show-inheritance:
126+
127+
.. autoclass:: cterasdk.exceptions.transport.BadGateway
128+
:noindex:
129+
:members:
130+
:show-inheritance:
131+
132+
.. autoclass:: cterasdk.exceptions.transport.ServiceUnavailable
133+
:noindex:
134+
:members:
135+
:show-inheritance:
136+
137+
.. autoclass:: cterasdk.exceptions.transport.GatewayTimeout
138+
:noindex:
139+
:members:
140+
:show-inheritance:

0 commit comments

Comments
 (0)