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.6.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

nextcloud_async-0.0.6-py3-none-any.whl (50.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nextcloud_async-0.0.6.tar.gz
  • Upload date:
  • Size: 57.9 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.6.tar.gz
Algorithm Hash digest
SHA256 f86010548d3d97fbf3bab774c1ba9ba3cc3413efb496f5b6350ba3104e282c0e
MD5 1653b73ce113fac502a315f569e369df
BLAKE2b-256 408ebb362aa1522d3f8ef3ee01df275fa9bd43664de183193d64dffc7614c8dd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nextcloud_async-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 35160b359c7307fa0c59aac0a9544a0c39dd85f167415d7b9ad8eff9591076c4
MD5 9374d62aeeb01e6d3491571a297cabf2
BLAKE2b-256 14b8ff99c5879a6158177c3fd56f5f159cb7a2c9818573bc75d17b0b54ab0af5

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