.. image:: https://travis-ci.org/owncloud/pyocclient.svg?branch=master :target: https://travis-ci.org/owncloud/pyocclient
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 <http://owncloud.org>_ for more information about ownCloud.
Supports connecting to ownCloud 8.2, 9.0, 9.1 and newer.
Automatic installation with pip:
.. code-block:: bash
$ pip install pyocclient
Manual installation of development version with git:
.. code-block:: bash
$ 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:
.. code-block:: python
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: " + link_info.get_link()
Example for uploading a file to a public shared folder:
.. code-block:: python
import owncloud
public_link = 'http://domain.tld/owncloud/A1B2C3D4'
oc = owncloud.Client.from_public_link(public_link)
oc.drop_file('myfile.zip')
Example for downloading a file from a public shared folder with password:
.. code-block:: python
import owncloud
public_link = 'http://domain.tld/owncloud/A1B2C3D4'
folder_password = 'secret'
oc = owncloud.Client.from_public_link(public_link, password=folder_password)
oc.get_file('/sharedfile.zip', 'download/destination/sharedfile.zip')
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:
.. code-block:: bash
$ pip install unittest-data-provider
Then run the script "runtests.sh":
.. code-block:: bash
$ ./runtests.sh
To build the documentation, you will need to install Sphinx and docutil. Then run the following commands:
.. code-block:: bash
$ 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".
FAQs
Python client library for ownCloud
We found that pyocclient demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.