nc-py-api 0.18.2__tar.gz → 0.19.1__tar.gz

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.19.1 - 2025-03-07]
+
+### Fixed
+
+- ExApps(NC32+): When using `HaRP`, use `unix-socket` instead of `host:port`.
+
+## [0.19.0 - 2025-02-15]
+
+### Added
+
+- Files: `FSNode` now have `creation_date` property. #335 Thanks to @SunnyFarmDay
+
+### Changed
+
+- ExApps: no longer require the `AA-VERSION` header. (Nextcloud 32+) #336
+- ExApps: `AppAPIAuthMiddleware` now secures the `websocket` connection. (Nextcloud 32+) #338
+
 ## [0.18.2 - 2025-01-19]
 
 ### Changed

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.18.2
+Version: 0.19.1
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/
@@ -87,7 +87,7 @@ Description-Content-Type: text/markdown
 [![Docs](https://github.com/cloud-py-api/nc_py_api/actions/workflows/docs.yml/badge.svg)](https://cloud-py-api.github.io/nc_py_api/)
 [![codecov](https://codecov.io/github/cloud-py-api/nc_py_api/branch/main/graph/badge.svg?token=C91PL3FYDQ)](https://codecov.io/github/cloud-py-api/nc_py_api)
 
-![NextcloudVersion](https://img.shields.io/badge/Nextcloud-27%20%7C%2028%20%7C%2029%20%7C%2030-blue)
+![NextcloudVersion](https://img.shields.io/badge/Nextcloud-%2028%20%7C%2029%20%7C%2030%20%7C%2031-blue)
 ![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 ![impl](https://img.shields.io/pypi/implementation/nc_py_api)
 ![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
@@ -95,6 +95,7 @@ Description-Content-Type: text/markdown
 Python library that provides a robust and well-documented API that allows developers to interact with and extend Nextcloud's functionality.
 
 ### The key features are:
+
  * **Fast**: High performance, and as low-latency as possible.
  * **Intuitive**: Fast to code, easy to use.
  * **Reliable**: Minimum number of incompatible changes.
@@ -102,24 +103,6 @@ Python library that provides a robust and well-documented API that allows develo
  * **Easy**: Designed to be easy to use with excellent documentation.
  * **Sync + Async**: Provides both sync and async APIs.
 
-### Capabilities
-| **_Capability_**             | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
-|------------------------------|:------------:|:------------:|:------------:|:------------:|
-| Calendar                     |      ✅       |      ✅       |      ✅       |      ✅       |
-| File System & Tags           |      ✅       |      ✅       |      ✅       |      ✅       |
-| Nextcloud Talk               |      ✅       |      ✅       |      ✅       |      ✅       |
-| Notifications                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Shares                       |      ✅       |      ✅       |      ✅       |      ✅       |
-| Users & Groups               |      ✅       |      ✅       |      ✅       |      ✅       |
-| User & Weather status        |      ✅       |      ✅       |      ✅       |      ✅       |
-| Other APIs**                 |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Settings UI API*             |     N/A      |     N/A      |      ✅       |      ✅       |
-| TaskProcessing Provider API* |     N/A      |     N/A      |     N/A      |      ✅       |
-
-&ast;_available only for **NextcloudApp**_<br>
-&ast;&ast;_Activity, Notes_
-
 ### Differences between the Nextcloud and NextcloudApp classes
 
 The **Nextcloud** class functions as a standard Nextcloud client,
@@ -136,8 +119,6 @@ but NextcloudApp has a broader selection since applications typically require ac
 Any code written for the Nextcloud class can easily be adapted for use with the NextcloudApp class,
 as long as it doesn't involve calls that require user password verification.
 
-**NextcloudApp** avalaible only from Nextcloud 27.1.2 and greater version with installed **AppAPI**.
-
 ### Nextcloud skeleton app in Python
 
 ```python3

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/README.md

@@ -8,7 +8,7 @@
 [![Docs](https://github.com/cloud-py-api/nc_py_api/actions/workflows/docs.yml/badge.svg)](https://cloud-py-api.github.io/nc_py_api/)
 [![codecov](https://codecov.io/github/cloud-py-api/nc_py_api/branch/main/graph/badge.svg?token=C91PL3FYDQ)](https://codecov.io/github/cloud-py-api/nc_py_api)
 
-![NextcloudVersion](https://img.shields.io/badge/Nextcloud-27%20%7C%2028%20%7C%2029%20%7C%2030-blue)
+![NextcloudVersion](https://img.shields.io/badge/Nextcloud-%2028%20%7C%2029%20%7C%2030%20%7C%2031-blue)
 ![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 ![impl](https://img.shields.io/pypi/implementation/nc_py_api)
 ![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
@@ -16,6 +16,7 @@
 Python library that provides a robust and well-documented API that allows developers to interact with and extend Nextcloud's functionality.
 
 ### The key features are:
+
  * **Fast**: High performance, and as low-latency as possible.
  * **Intuitive**: Fast to code, easy to use.
  * **Reliable**: Minimum number of incompatible changes.
@@ -23,24 +24,6 @@ Python library that provides a robust and well-documented API that allows develo
  * **Easy**: Designed to be easy to use with excellent documentation.
  * **Sync + Async**: Provides both sync and async APIs.
 
-### Capabilities
-| **_Capability_**             | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
-|------------------------------|:------------:|:------------:|:------------:|:------------:|
-| Calendar                     |      ✅       |      ✅       |      ✅       |      ✅       |
-| File System & Tags           |      ✅       |      ✅       |      ✅       |      ✅       |
-| Nextcloud Talk               |      ✅       |      ✅       |      ✅       |      ✅       |
-| Notifications                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Shares                       |      ✅       |      ✅       |      ✅       |      ✅       |
-| Users & Groups               |      ✅       |      ✅       |      ✅       |      ✅       |
-| User & Weather status        |      ✅       |      ✅       |      ✅       |      ✅       |
-| Other APIs**                 |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Settings UI API*             |     N/A      |     N/A      |      ✅       |      ✅       |
-| TaskProcessing Provider API* |     N/A      |     N/A      |     N/A      |      ✅       |
-
-&ast;_available only for **NextcloudApp**_<br>
-&ast;&ast;_Activity, Notes_
-
 ### Differences between the Nextcloud and NextcloudApp classes
 
 The **Nextcloud** class functions as a standard Nextcloud client,
@@ -57,8 +40,6 @@ but NextcloudApp has a broader selection since applications typically require ac
 Any code written for the Nextcloud class can easily be adapted for use with the NextcloudApp class,
 as long as it doesn't involve calls that require user password verification.
 
-**NextcloudApp** avalaible only from Nextcloud 27.1.2 and greater version with installed **AppAPI**.
-
 ### Nextcloud skeleton app in Python
 
 ```python3

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/_session.py

@@ -478,7 +478,6 @@ class NcSessionAppBasic(ABC):
 
     def sign_check(self, request: HTTPConnection) -> str:
         headers = {
-            "AA-VERSION": request.headers.get("AA-VERSION", ""),
             "EX-APP-ID": request.headers.get("EX-APP-ID", ""),
             "EX-APP-VERSION": request.headers.get("EX-APP-VERSION", ""),
             "AUTHORIZATION-APP-API": request.headers.get("AUTHORIZATION-APP-API", ""),

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.18.2"
+__version__ = "0.19.1"

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/ex_app/__init__.py

@@ -10,7 +10,7 @@ from .integration_fastapi import (
     set_handlers,
     talk_bot_msg,
 )
-from .logging import setup_nextcloud_logging
+from .logger import setup_nextcloud_logging
 from .misc import (
     get_computation_device,
     get_model_path,

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/ex_app/integration_fastapi.py

@@ -241,7 +241,7 @@ class AppAPIAuthMiddleware:
 
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         """Method that will be called by Starlette for each event."""
-        if scope["type"] != "http":
+        if scope["type"] not in ("http", "websocket"):
             await self.app(scope, receive, send)
             return
 

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/ex_app/uvicorn_fastapi.py

@@ -22,4 +22,18 @@ def run_app(
     :param args: Any args to pass to **uvicorn.run**.
     :param kwargs: Any **kwargs** to pass to **uvicorn.run**, except ``host`` and ``port``.
     """
-    uvicorn.run(uvicorn_app, *args, host=environ.get("APP_HOST", "127.0.0.1"), port=int(environ["APP_PORT"]), **kwargs)
+    if environ.get("HP_SHARED_KEY"):
+        uvicorn.run(
+            uvicorn_app,
+            *args,
+            uds=environ.get("HP_EXAPP_SOCK", "/tmp/exapp.sock"),
+            **kwargs,
+        )
+    else:
+        uvicorn.run(
+            uvicorn_app,
+            *args,
+            host=environ.get("APP_HOST", "127.0.0.1"),
+            port=int(environ["APP_PORT"]),
+            **kwargs,
+        )

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/files/__init__.py

@@ -86,6 +86,7 @@ class FsNodeInfo:
     is_version: bool
     """Flag indicating if the object is File Version representation"""
     _last_modified: datetime.datetime
+    _creation_date: datetime.datetime
     _trashbin: dict
 
     def __init__(self, **kwargs):
@@ -102,6 +103,10 @@ class FsNodeInfo:
             self.last_modified = kwargs.get("last_modified", datetime.datetime(1970, 1, 1))
         except (ValueError, TypeError):
             self.last_modified = datetime.datetime(1970, 1, 1)
+        try:
+            self.creation_date = kwargs.get("creation_date", datetime.datetime(1970, 1, 1))
+        except (ValueError, TypeError):
+            self.creation_date = datetime.datetime(1970, 1, 1)
         self._trashbin: dict[str, str | int] = {}
         for i in ("trashbin_filename", "trashbin_original_location", "trashbin_deletion_time"):
             if i in kwargs:
@@ -142,6 +147,18 @@ class FsNodeInfo:
         else:
             self._last_modified = value
 
+    @property
+    def creation_date(self) -> datetime.datetime:
+        """Time when the object was created."""
+        return self._creation_date
+
+    @creation_date.setter
+    def creation_date(self, value: str | datetime.datetime):
+        if isinstance(value, str):
+            self._creation_date = email.utils.parsedate_to_datetime(value)
+        else:
+            self._creation_date = value
+
     @property
     def in_trash(self) -> bool:
         """Returns ``True`` if the object is in trash."""

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/files/_files.py

@@ -16,6 +16,7 @@ from . import FsNode, SystemTag
 PROPFIND_PROPERTIES = [
     "d:resourcetype",
     "d:getlastmodified",
+    "d:creationdate",
     "d:getcontentlength",
     "d:getcontenttype",
     "d:getetag",
@@ -45,6 +46,7 @@ SEARCH_PROPERTIES_MAP = {
     "name": "d:displayname",  # like, eq
     "mime": "d:getcontenttype",  # like, eq
     "last_modified": "d:getlastmodified",  # gt, eq, lt
+    "creation_date": "d:creationdate",  # gt, eq, lt
     "size": "oc:size",  # gt, gte, eq, lt
     "favorite": "oc:favorite",  # eq
     "fileid": "oc:fileid",  # eq
@@ -286,6 +288,8 @@ def _parse_record(full_path: str, prop_stats: list[dict]) -> FsNode:  # noqa pyl
             fs_node_args["etag"] = prop["d:getetag"]
         if "d:getlastmodified" in prop_keys:
             fs_node_args["last_modified"] = prop["d:getlastmodified"]
+        if "d:creationdate" in prop_keys:
+            fs_node_args["creation_date"] = prop["d:creationdate"]
         if "d:getcontenttype" in prop_keys:
             fs_node_args["mimetype"] = prop["d:getcontenttype"]
         if "oc:permissions" in prop_keys:

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/nc_py_api/nextcloud.py

@@ -29,7 +29,7 @@ from ._talk_api import _AsyncTalkAPI, _TalkAPI
 from ._theming import ThemingInfo, get_parsed_theme
 from .activity import _ActivityAPI, _AsyncActivityAPI
 from .apps import _AppsAPI, _AsyncAppsAPI
-from .calendar import _CalendarAPI
+from .calendar_api import _CalendarAPI
 from .ex_app.defs import LogLvl
 from .ex_app.events_listener import AsyncEventsListenerAPI, EventsListenerAPI
 from .ex_app.occ_commands import AsyncOccCommandsAPI, OccCommandsAPI

{nc_py_api-0.18.2 → nc_py_api-0.19.1}/pyproject.toml

@@ -139,6 +139,7 @@ lint.extend-ignore = [
   "D401",
   "I001",
   "RUF100",
+  "S108",
 ]
 
 lint.per-file-ignores."nc_py_api/__init__.py" = [