Python wrapper for NextCloud api
Project description
Overview
Python wrapper for NextCloud’s API.
The lib tends to support most common features i.e. :
User provisioning
OCS Share
WebDAV (files)
Tags
Activity app
Notifications app
LDAP configuration
Capabilities
Group Folders
Tested with :
NextCloud 14, python 3.7 (automated test)
NextCloud 20, python 2.7
NextCloud 20, python 3.6
The main lines :
NextCloud(URL, auth=…) provide you a connection manager. You can use it with with … as nxc: to open a session.
The session is the connection object that make the requests.
The requests are initiated by a requester associated to an API wrapper.
API wrappers are the definition of how to use the NextCloud REST API : it provide functions that will be attached to the NextCloud object.
Functions can return : - Response object with attributes is_ok, data. If is_ok is False, you can use get_error_message. - Data objects (File, Tag…) or None.
Data objects are useable as dict object or with attribute. They provide operations. If the operation fails, you’ll get an exception.
Install
# use 'pip3' for python3 or 'python -m pip' instead of pip
pip install nextcloud-api-wrapper
# the associated python lib is nammed 'nextcloud'
# beware the conflicts
Fork Changes
This version is a fork (mainly refactoring, fixes and optimization) of nextcloud-API .
Testing
The integration to Travis and CodeCov provided by the original repository are lost.
There is now 2 branches develop and main. All tests are validated using test.sh docker before merging develop to main.
Documentation
The integration with readthedoc.io is lost. You still can build the documentation with Sphinx source.
Looking at the code docstrings is recommended. Significative changes will be reported in CHANGELOG.md file.
Too, you can check out the original nextcloud API documentation, but the use could have changed.
Contributing
Pull Request
According to the testing procedure, you shall fork and PR on branch develop.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for nextcloud-api-wrapper-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30ac51f86a7a00506a376034f804cc1fe70385496443fb75de6064d7c1f97a6e |
|
MD5 | 41cd5b479dfa05aa862fe6f57eddc906 |
|
BLAKE2b-256 | 7ae9cc5f0495f829d3954d116c9c7c3244e4dab67a8d423b3ee03ff8ec268bbd |
Hashes for nextcloud_api_wrapper-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1899650073f1428cb12837bd61b0accd95ca54612752c42f901d7bd49deeea75 |
|
MD5 | 44ef8c39448a5f8786f95a5cce13a917 |
|
BLAKE2b-256 | 2f984bc095753ba11f0c31e3be3eb47ded593f5fdafa04f73831fe791cfcee45 |
Hashes for nextcloud_api_wrapper-0.2.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a30e66e4fbe451692c050c15b2dc6130df5547bd53e29db548d8141303c03e48 |
|
MD5 | 2181396f7fa2ffe895b43d50d00e7054 |
|
BLAKE2b-256 | 354b64c695886f8e39c823a2bc7b9b969a4e5fe8525e85dea27cbdaf0e2e4b43 |