---
id: nc-py-api
version: "0.30.3"
license: BSD-3-Clause
license_treatment: permissive
maintenance: active
---

# nc-py-api — Nextcloud Python Framework

License: permissive · Maintenance: active · Downloads: 1.0M/mo

## What it is and what it does

nc-py-api is a Python framework for interacting with Nextcloud servers and building Nextcloud applications. It provides two main client classes: Nextcloud (for standard client authentication via username/password) and NextcloudApp (for building full Nextcloud applications with graphical interfaces and multi-user support via AppAPI). The library is async-first, with sync wrappers being gradually removed; as of version 0.30.0, several modules (Activity, Notes, User Status, Weather Status) have already dropped sync support.

The package depends on fastapi, starlette, pydantic, niquests, filelock, python-dotenv, and xmltodict. It is actively maintained, supports Python 3.10 through 3.14, and runs on CPython and PyPy. The library is in Beta status and has no known security vulnerabilities.

Use it for:

- Build a Python application that reads or modifies files, users, or settings on a Nextcloud server
- Create a Nextcloud app with a web interface that integrates with the Nextcloud ecosystem
- Automate Nextcloud administration tasks (user management, file operations, logging)
- Develop a custom integration or sync tool between Nextcloud and external systems
- Monitor or audit Nextcloud activity and user status programmatically

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Python client library for interacting with Nextcloud servers and building Nextcloud applications via async and sync APIs.

Yes. Active maintenance, low install friction, permissive license, no known vulnerabilities, and broad Python version support make this a solid choice for Nextcloud integration. The async-first design is modern; be aware that sync wrappers are being phased out, so new code should target the async API.

## Install

pip install nc-py-api
uv add nc-py-api
poetry add nc-py-api

## Installing nc-py-api

Before you install: Low friction installation with a pure-Python wheel. Active maintenance with a release 3 days ago and recent commits. Supports modern Python versions (3.10–3.14) and runs on CPython and PyPy.

License in practice: BSD-3-Clause permissive license allows commercial and private use with minimal restrictions; attribution required.

Quickstart:

pip install nc-py-api

from nc_py_api import AsyncNextcloud

nc = AsyncNextcloud(nextcloud_url="https://example.com", user="user", password="pass")
await nc.users.list()

Requires Python 3.10 or later. Async API is primary; sync wrappers are being phased out as of version 0.30.0.

Verify before relying:

- Whether the library's test coverage claim ('all code covered with tests as much as possible') reflects actual coverage percentage
- Performance characteristics and latency benchmarks for typical Nextcloud API operations
- Which specific Nextcloud server versions are supported and tested

## Package facts

- License: BSD-3-Clause (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 1.0M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

nextcloud python client, nextcloud api library, nextcloud app framework, async nextcloud integration, nextcloud server interaction, python nextcloud sdk, nextcloud application development, nextcloud-integration, async-first, app-framework

[View on SkillFed](https://skillfed.io/packages/nc-py-api) · [View on PyPI](https://pypi.org/project/nc-py-api/)