Metadata-Version: 2.1
Name: nc-py-api
Version: 0.0.10
Summary: Backend API for Python 3.9+ to work with Nextcloud
Home-page: https://github.com/cloud-py-api/cloud-py-api
Author: Alexander Piskun
Author-email: bigcat88@users.noreply.github.com
License: Apache License 3.0
Project-URL: Source, https://github.com/cloud-py-api/cloud-py-api
Keywords: nextcloud,api,framework
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# Nextcloud Python Framework

[![(Py)Analysis & Coverage](https://github.com/cloud-py-api/cloud_py_api/actions/workflows/py_analysis-coverage.yml/badge.svg)](https://github.com/cloud-py-api/cloud_py_api/actions/workflows/py_analysis-coverage.yml)
![PythonVersion](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)
![impl](https://img.shields.io/pypi/implementation/nc_py_api)
![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
[![codecov](https://codecov.io/gh/cloud-py-api/cloud_py_api/branch/main/graph/badge.svg?token=6IHPKUYUU9)](https://codecov.io/gh/cloud-py-api/cloud_py_api)

Framework(App) for Nextcloud to develop apps, that using Python.

Consists of PHP part(**cloud_py_api app**) and a Python module(**nc-py-api**).

| **Currently in development, all is in a design state**

## Provides Convenient Functions for Python

- Read & Write File System objects
- Working with Database
- Wrapper around `OCC` calls
- Calling your python function from php part of app and return a result

## 🚀 Installation

In your Nextcloud, simply enable the `cloud_py_api` app through the Apps management and then install apps, that using it.

The Nextcloud `cloud_py_api` app supports Nextcloud version 25 and higher.

#### More information can be found on [Wiki page](https://github.com/cloud-py-api/cloud_py_api/wiki)

## Maintainers

* [Andrey Borysenko](https://github.com/andrey18106)
* [Alexander Piskun](https://github.com/bigcat88)

## Apps using this

- [MediaDC](https://github.com/andrey18106/mediadc) - Nextcloud Media Duplicate collector app. Python part - core logics for duplicates search.

## Support

You can support us in several ways:

- ⭐ Star our work (it really motivates)
- ❗ Create an Issue or feature request (bring to us an excellent idea)
- 💁 Resolve some Issue or create a Pull Request (contribute to this project)
- 🪙 Donate with any amount with one of the links below (fund this project)

[![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate?hosted_button_id=H5PLJJMWLDNJQ)
[![Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/cloud_py_api/donate)
