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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nextcloud_async-0.0.10-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nextcloud_async-0.0.10.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for nextcloud_async-0.0.10.tar.gz
Algorithm Hash digest
SHA256 a0c8e92d5567925bc97812d2e755a06f5ad9a6b8da0ac0d0c0faa8558678d284
MD5 0d284255bf886e01aee0a24e01d3e717
BLAKE2b-256 18cc56e6d9d1e77bd96556bfeee1a352e8eaf9c651d27000ef369162ec0c44e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nextcloud_async-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 059f395e8087aab44e009e54e84cdc6427309a8dc60f9d27eeaf3dc3b491c2ef
MD5 ebe55d8c92e80d20f9abef02215afe35
BLAKE2b-256 a11c22f16f709dc51c5133e4b3d925fb1efb889c4ea07e323a070920003d152c

See more details on using hashes here.

Supported by

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