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

Uploaded Source

Built Distribution

nextcloud_async-0.0.5-py3-none-any.whl (50.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nextcloud_async-0.0.5.tar.gz
  • Upload date:
  • Size: 57.3 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.5.tar.gz
Algorithm Hash digest
SHA256 3b261164dc89210defd8c193d02b4c79aba95bf3a55f25740f49636df5126cae
MD5 776d252d78fa5e137e227126184f50b7
BLAKE2b-256 f589c8aff5a1577b925b14a26067572d0a64b1c8fe3154c5c768ade7110d4d70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nextcloud_async-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e84d3b92710c23d7242417d78efb808c78d15c4291ff7e3f0d91c5ec78d9aed8
MD5 cc0a23a616335671de1770e679640438
BLAKE2b-256 b547474e9cffa0c8e08dfe98aec7b3108184549eb3ba943551ae8f8fb3fc1e70

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