owncloud/pyocclient

⚠️ This repository is archived and no longer maintained. It is read-only and will not receive further updates or contributions.

pyocclient

A pure Python client library for the ownCloud API. It provides functions for file operations (upload, download, directory listing, chunked upload), sharing via the OCS Share API, user and group management via the OCS Provisioning API, and app management -- abstracting away the underlying HTTP and WebDAV calls.

Note: This repository is in maintenance/legacy mode and is no longer actively developed.

Getting Started

Follow the steps below to install and use the Python client library.

Installation

pip install pyocclient

Usage

import owncloud

oc = owncloud.Client('http://your-owncloud-instance.example.com/')
oc.login('user', 'password')

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

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

Run Tests

bash runtests.sh

Documentation

• PyPI: pyocclient
• API Documentation

Part of ownCloud Infrastructure

This library was the official Python SDK for ownCloud Server 8.2 through 9.x.

Note: This repository is archived/legacy and is no longer actively maintained.

Community & Support

Star this repo and Watch for release notifications!

• ownCloud Website
• Community Discussions
• Matrix Chat
• Documentation
• Enterprise Support
• OSPO Home

Contributing

We welcome contributions! Please read the Contributing Guidelines and our Code of Conduct before getting started.

Workflow

• Rebase Early, Rebase Often! We use a rebase workflow. Always rebase on the target branch before submitting a PR.
• Dependabot: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
• Signed Commits: All commits must be PGP/GPG signed. See GitHub's signing guide.
• DCO Sign-off: Every commit must carry a Signed-off-by line:

  git commit -s -S -m "your commit message"
  

• GitHub Actions Policy: Workflows may only use actions that are (a) owned by owncloud, (b) created by GitHub (actions/*), or (c) verified in the GitHub Marketplace.

Security

Do not open a public GitHub issue for security vulnerabilities.

Report vulnerabilities at https://security.owncloud.com -- see SECURITY.md.

Bug bounty: YesWeHack ownCloud Program

License

This project is licensed under the MIT.

About the ownCloud OSPO

The Kiteworks Open Source Program Office, operating under the ownCloud brand, launched on May 5, 2026, to steward the open source ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, community health, and sustainable collaboration between the open source community and Kiteworks, which acquired ownCloud in 2023.

• OSPO Home: https://kiteworks.com/opensource
• GitHub: https://github.com/owncloud
• ownCloud: https://owncloud.com

For questions about the OSPO or licensing, contact [email protected].

License Migration to Apache 2.0

The OSPO is driving a strategic relicensing of ownCloud repositories toward the Apache License 2.0, following the Apache Software Foundation's third-party license policy.

Individual repositories will migrate as their audit is completed. The LICENSE file in each repo reflects its current license status (not the target).

Current license: MIT (Category A per Apache policy -- permissive, compatible with Apache-2.0).

Migration prerequisites for this repository:

• CLA/DCO coverage: All past contributors must have signed agreements permitting relicensing
• Header updates: All source file headers must be updated from MIT to Apache-2.0 notice
• Dependency audit: Verify no incompatible transitive dependencies