PyOCClient

https://pypi.org/project/pyocclient/
Admin
PyOCClient is a Python client library that enables programmatic interaction with ownCloud instances...
Tokens:2,911
Snippets:61
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install PyOCClient with Pip

Source: https://pypi.org/project/pyocclient

Use pip for automatic installation of the pyocclient library.

```bash
$ pip install pyocclient
```

--------------------------------

### Build Documentation with Sphinx

Source: https://pypi.org/project/pyocclient

Install Sphinx and docutil, then run these commands to build the HTML documentation. The output will be in the 'doc/build/html' directory.

```bash
$ sphinx-apidoc -e -f -o docs/source owncloud/ owncloud/test
$ cd docs
$ make html
```

--------------------------------

### Install unittest-data-provider

Source: https://pypi.org/project/pyocclient

Install the unittest-data-provider package required for running unit tests.

```bash
$ pip install unittest-data-provider
```

--------------------------------

### Upload and Share File

Source: https://pypi.org/project/pyocclient

Example demonstrating how to upload a file to a directory and then share it via a link. Requires owncloud client initialization and login.

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

--------------------------------

### Install PyOCClient Development Version

Source: https://pypi.org/project/pyocclient

Manually install the development version of pyocclient from GitHub.

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

--------------------------------

### Build HTML Documentation

Source: https://pypi.org/project/pyocclient/0.6

Build the HTML version of the documentation after generating the source files. Navigate to the docs directory first.

```bash
$ cd docs
$ make html
```

--------------------------------

### Run Unit Tests

Source: https://pypi.org/project/pyocclient

Execute the unit tests using the provided runtests.sh script after setting up the configuration file.

```bash
$ ./runtests.sh
```

--------------------------------

### Generate Sphinx Documentation

Source: https://pypi.org/project/pyocclient/0.6

Generate API documentation using sphinx-apidoc. This command prepares the documentation source files.

```bash
$ sphinx-apidoc -e -f -o docs/source owncloud/ owncloud/test
```

--------------------------------

### Upload File to Public Shared Folder

Source: https://pypi.org/project/pyocclient

Upload a file to a folder that is accessible via a public link. The Client is initialized using a public link.

```python
import owncloud

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

oc = owncloud.Client.from_public_link(public_link)
oc.drop_file('myfile.zip')
```

--------------------------------

### Download File from Password-Protected Public Share

Source: https://pypi.org/project/pyocclient

Download a file from a public shared folder that requires a password. The Client is initialized with the public link and the password.

```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')
```
Tokens:
Raw