pyncclient 0.7

Python client library for nextCloud

This is a fork of https://github.com/owncloud/pyocclient to provide compatibility with nextCloud, this client will not maintain compatibility to ownCloud.

Features

General information

• retrieve information about nextCloud instance (e.g. version, host, URL, etc.)

Accessing files

• basic file operations like getting a directory listing, file upload/download, directory creation, etc

• read/write file contents from strings

• upload with chunking and mtime keeping

• upload whole directories

• directory download as zip

• access files from public links

• upload files to files drop link target

Sharing (OCS Share API)

• share a file/directory via public link

• share a file/directory with another user or group

• unshare a file/directory

• check if a file/directory is already shared

• get information about a shared resource

• update properties of a known share

Apps (OCS Provisioning API)

• enable/disable apps

• retrieve list of enabled apps

Users (OCS Provisioning API)

• create/delete users

• create/delete groups

• add/remove user from groups

App data

• store app data as key/values using the privatedata OCS API

Requirements

• Python >= 2.7 or Python >= 3.5

• requests module (for making HTTP requests)

Installation

Automatic installation with pip:

$ pip install pyncclient

Manual installation of development version with git:

$ pip install requests
$ git clone https://github.com/pragmaticindustries/pyncclient.git
$ cd pyncclient
$ python setup.py install

Usage

Example for uploading a file then sharing with link:

import nextcloud_client

nc = nextcloud_client.Client('http://domain.tld/nextcloud')

nc.login('user', 'password')

nc.mkdir('testdir')

nc.put_file('testdir/remotefile.txt', 'localfile.txt')

link_info = nc.share_file_with_link('testdir/remotefile.txt')

print("Here is your link: " + link_info.get_link())

Example for uploading a file to a public shared folder:

import nextcloud_client

public_link = 'http://domain.tld/nextcloud/A1B2C3D4'

nc = nextcloud_client.Client.from_public_link(public_link)
nc.drop_file('myfile.zip')

Example for downloading a file from a public shared folder with password:

import nextcloud_client

public_link = 'http://domain.tld/nextcloud/A1B2C3D4'
folder_password = 'secret'

nc = nextcloud_client.Client.from_public_link(public_link, password=folder_password)
nc.get_file('/sharedfile.zip', 'download/destination/sharedfile.zip')

Running the unit tests

To run the unit tests, create a config file called “nextcloud_client/test/config.py”. There is a config file example called “nextcloud_client/test/config.py.sample”. All the information required is in that file. It should point to a running nextCloud instance to test against.

You might also need to install the unittest-data-provider package:

$ pip install unittest-data-provider

Then run the script “runtests.sh”:

$ ./runtests.sh

Building the documentation

To build the documentation, you will need to install Sphinx and docutil. Then run the following commands:

$ sphinx-apidoc -e -f -o docs/source nextcloud_client/ nextcloud_client/test
$ cd docs
$ make html

You can then find the documentation inside of “doc/build/html”.

Contributors

Contributors

• Marco Mastasi <[e-mail]>

Changelog

0.7 – - Made initial changes for nextCloud compatibility

0.6

• Added support to query arbitrary properties with file info and file listing [NikosChondros]

• Added support for file operations within a public link [mrwunderbar666]

0.5

• Added “name” attribute for public links [PVince81]

• Fixed deprecation warnings [Tilman Lüttje] [PVince81]

• Added support sharing with federated users [remjg]

• Fixed setup script for utf-8 paths [amicitas]

• Fixed file mtime parsing issue [viraj96]

• Add support for the server’s DAV v2 endpoint [PVince81]

• Remove support for ownCloud 8.1, 9.0 and 9.1 which are EOL [PVince81]

0.4

• Some code cleanup removing needless if statements [jamescooke]

• Remove old session_mode [PVince81]

• Set Depth to 0 in file_info call [PVince81]

• Make subclassing of Client event easier with protected methods [bobatsar]

0.3

• Make subclassing of Client easier [bobatsar]

• Add Depth param for recursive listing [bobatsar]

• Add shared_with_me parameter to get_shares [bobatsar]

• Link variable is now called url inside of shareinfo [SergioBertolinSG]

• Python3 support [ethifus] [Blizzz]

0.2

• Webdav COPY support [individual-it]

• Added API for federated sharing [nickvergessen]

• Fix login issue in case of failed login [individual-it]

• Added function to get capabilities [SergioBertolinSG]

• Added subadmin APIs for provisioning API [svigneux]

• Tests for provisioning API [individual-it]

• Added provisioning API functions [jennifer]

• Code cleanup / PEP8 formatting [jennifer]

• Added status check function [soalhn]

• Added share API functions [soalhn] [SergioBertolinSG]

• Travis integration [Gomez]

• Added session handling workaround for OC 5 [PVince81]

• Fixed many issues related to unicode path names [PVince81]

• Client now works properly on Windows [PVince81]

0.1

• Make python egg [PVince81]

• Initial release [PVince81]