Nextcloud cookbook API

Python API client for nextcloud cookbook app API

Table of contents

1. About
2. Installation
   1. Installation from pip
   2. Installation from source
3. Usage
4. License

About

This is a Python API client for the Nextcloud Cookbook app API. It allows you to interact with your Nextcloud Cookbook instance programmatically, enabling you to manage recipes, ingredients, and other related data.

Installation

Installation from pip

Install the latest version of the API client from pip:

pip install nextcloud-cookbook-api

You can also very easily update to a newer version:

pip install -U nextcloud-cookbook-api

Installation from source

You can also install the latest version of the API client directly from source:

git clone https://github.com/infinityofspace/nextcloud_cookbook_api.git
cd nextcloud_cookbook_api
pip install .

Usage

You can find the full documentation for the API client here.

Development

Setup environment

First get the source code:

git clone https://github.com/infinityofspace/nextcloud_cookbook_api.git
cd nextcloud_cookbook_api

Now create a virtual environment, activate it and install all dependencies with the following commands:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Now you can start developing.

Contributing

Feel free to contribute to this project by creating a pull request. Before you create a pull request, make sure that you code meets the following requirements (you can use the specified commands to check/fulfill the requirements):

1. check unit tests: python -m unittest tests/**/*.py
2. format the code: ruff format
3. check linting errors: ruff check

Tests

You can run the tests with the following command:

python -m unittest tests/*.py

Documentation

To build the documentation, you can use the following commands:

sphinx-apidoc -f -o docs/source nextcloud_cookbook_api
cd docs && make html

License

This project is licensed under the MIT License - see the LICENSE file for details.