Python client library for ownCloud
Project description
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.
Features
Supports connecting to ownCloud 8, 9 and newer.
General information
retrieve information about ownCloud 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
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 (no support for Python 3 yet)
requests module (for making HTTP requests)
Installation
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
Usage
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
Running the unit tests
To run the unit tests, create a config file called “owncloud/test/config.py”. There is a config file example called “owncloud/test/config.py.sample”. All the information required is in that file. It should 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.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 owncloud/ owncloud/test
$ cd docs
$ make html
You can then find the documentation inside of “doc/build/html”.
Contributors
Contributors
Vincent Petry <pvince81@owncloud.com>
Steffen Lindner <mail@steffen-lindner.de>
Soal <soal@soal.pl>
Bruno Santeramo <bruno.santeramo@gmail.com>
jennifer <jennifer@owncloud.com>
Sergio Bertolín <sbertolin@solidgear.es>
Alessandro Cosentino <cosenal@gmail.com>
Mike <mike@x220>
Joas Schilling <nickvergessen@owncloud.com>
Individual IT Services <info@individual-it.net>
Juan Pablo Villafáñez <jvillafanez@solidgear.es>
Simon Vigneux <svigneux@kronostechnologies.com>
Roeland Jago Douma <rullzer@owncloud.com>
Erik Pellikka <erik@pellikka.org>
Changelog
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]