pyocclient Python Client for ownCloud

You can install pyocclient using pip for the standard version, or manually from the git repository for development.

Requirements:

• Python >= 2.7 or Python >= 3.5
• requests module

$ pip install pyocclient

To use the library, initialize an owncloud.Client with your ownCloud instance URL and authenticate using login(). The client provides high-level abstractions for file operations and directory management, removing the need to handle HTTP or WebDAV calls manually.

import owncloud

# Initialize the client with your server URL
oc = owncloud.Client('http://your-owncloud-instance.example.com/')

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

# Upload a file to a remote path
oc.put_file('remote/path/file.txt', 'local/file.txt')

# List items in a directory
for item in oc.list('/'):
    print(item)

Install the pyocclient library using pip to use the Python client for ownCloud API operations.

pip install pyocclient

pyocclient provides specialized methods to interact with public shared folders without standard user credentials.

Upload to a public drop link

Use owncloud.Client.from_public_link(public_link) and the drop_file method.

Download from a password-protected public link

Use owncloud.Client.from_public_link(public_link, folder_password=folder_password) and the get_file method.

import owncloud

# Uploading to a public link
public_link = 'http://domain.tld/owncloud/A1B2C3D4'
oc = owncloud.Client.from_public_link(public_link)
oc.drop_file('myfile.zip')

# Downloading from a password-protected public link
public_link = 'http://domain.tld/owncloud/A1B2C3D4'
folder_password = 'secret'
oc = owncloud.Client.from_public_link(public_link, folder_password=folder_password)
oc.get_file('/sharedfile.zip', 'download/destination/sharedfile.zip')

To interact with a private ownCloud instance, instantiate owncloud.Client with your server URL, log in with credentials, and use methods like mkdir, put_file, and share_file_with_link.

Note: This library is a functional abstraction for APIs and is not a sync client implementation.

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()

Execute the test suite using the provided shell script.

bash runtests.sh