Python library that provides a robust and well-documented API that allows developers to interact with and extend Nextcloud's functionality.
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 | ✅ |
*available only for NextcloudApp
**Activity, Notes
The Nextcloud class functions as a standard Nextcloud client, enabling you to make API requests using a username and password.
On the other hand, the NextcloudApp class is designed for creating applications for Nextcloud.
It uses AppAPI to provide additional functionality allowing
applications have their own graphical interface, fulfill requests from different users,
and everything else that is necessary to implement full-fledged applications.
Both classes offer most of the same APIs, but NextcloudApp has a broader selection since applications typically require access to more APIs.
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.
from contextlib import asynccontextmanager
from fastapi import FastAPI
from nc_py_api import NextcloudApp
from nc_py_api.ex_app import AppAPIAuthMiddleware, LogLvl, run_app, set_handlers
@asynccontextmanager
async def lifespan(app: FastAPI):
set_handlers(app, enabled_handler)
yield
APP = FastAPI(lifespan=lifespan)
APP.add_middleware(AppAPIAuthMiddleware)
def enabled_handler(enabled: bool, nc: NextcloudApp) -> str:
if enabled:
nc.log(LogLvl.WARNING, "Hello from nc_py_api.")
else:
nc.log(LogLvl.WARNING, "Bye bye from nc_py_api.")
return ""
if __name__ == "__main__":
run_app("main:APP", log_level="trace")
You can support us in several ways: