This pure python library makes it possible to connect to an ownCloud instance and perform file, share and attribute operations.

Please note that this is not a sync client implementation but a library that provides functions to abstract away HTTP calls for various ownCloud APIs.

See the ownCloud homepage for more information about ownCloud.

Supports connecting to ownCloud 5, 6, 7, 8 and newer.

Please note that ownCloud 5 will require setting the "single_session" constructor option to False for some API calls.

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

• 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

• 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

• enable/disable apps
• retrieve list of enabled apps

• create/delete users
• create/delete groups
• add/remove user from groups

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

• Python >= 2.7 (no support for Python 3 yet)
• requests module (for making HTTP requests)

Automatic installation with pip:

$ pip install pyocclient

Manual installation of development version with git:

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

Example for uploading a file then sharing with link:

import owncloud

oc = owncloud.Client('http://domain.tld/owncloud')

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

oc.mkdir('testdir')

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

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

print "Here is your link: http://domain.tld/owncloud/" + link_info.link

To run the unit tests, edit the config file in "owncloud/test/config.py" to point to a running ownCloud 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.py":

$ ./runtests.py

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

$ cd docs
$ make html

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

• Vincent Petry (@pvince81)
• Steffen Lindner (@gomezr)
• Soal (@soalhn)