Skip to main content

Asynchronous client library for Nextcloud

Project description

nextcloud-async

Asynchronous Nextcloud Client

This module provides an asyncio-friendly interface to public NextCloud APIs.

Covered APIs

  • File Management API
  • User Management API
  • Group Management API
  • GroupFolders API
  • App Management API
  • LDAP Configuration API
  • Status API
  • Share API (except Federated shares)
  • Talk/spreed API
  • Notifications API
  • Login Flow v2 API
  • Remote Wipe API
  • Maps API

APIs To Do

  • Sharee API
  • Reaction API
  • User Preferences API
  • Federated Shares API
  • Cookbook API
  • Passwords API
  • Notes API
  • Deck API
  • Calendar CalDAV API
  • Tasks CalDAV API
  • Contacts CardDAV API

If you know of any APIs missing from this list, please open an issue at https://github.com/aaronsegura/nextcloud-async/issues with a link to the API documentation so it can be added. This project aims to eventually cover any API provided by NextCloud and commonly used NextCloud apps.

Example Usage

import httpx
import asyncio
from nextcloud_async import NextCloudAsync

nca = NextCloudAsync(
    client=httpx.AsyncClient(),
    endpoint='http://localhost:8181',
    user='user',
    password='password')

async def main():
    users = await nca.get_users()
    tasks = [nca.get_user(user) for user in users]
    results = await asyncio.gather(*tasks)
    for user_info in results:
        print(user_info)

if __name__ == "__main__":
    asyncio.run(main())

This project is not endorsed or recognized in any way by the NextCloud project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nextcloud_async-0.0.4.tar.gz (58.6 kB view details)

Uploaded Source

Built Distribution

nextcloud_async-0.0.4-py3-none-any.whl (51.9 kB view details)

Uploaded Python 3

File details

Details for the file nextcloud_async-0.0.4.tar.gz.

File metadata

  • Download URL: nextcloud_async-0.0.4.tar.gz
  • Upload date:
  • Size: 58.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for nextcloud_async-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6a1447c3c89f09bea18683a1e781bbefd3cec554a4aac058119606fda0a4c66c
MD5 8828a9291163b6797761367e77d82271
BLAKE2b-256 13e46c1ebc17fb86bce495eb2a77caa6f6005fbb673c349cad40c59f5db3c7a1

See more details on using hashes here.

File details

Details for the file nextcloud_async-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for nextcloud_async-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c260b0b1bb94884588935b1734c243425672e7663a2fe2a229a1955ec9b744d8
MD5 fa7c6fddc1c36b264f3ea6c1524c933c
BLAKE2b-256 d0cdfcbb7df418e126c605eec0696db33a19a6ba661702703ff2a17fe4c8f239

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page