File: Installation.rst

package info (click to toggle)
nc-py-api 0.19.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,320 kB
  • sloc: python: 12,415; makefile: 238; xml: 100; javascript: 56; sh: 14
file content (32 lines) | stat: -rw-r--r-- 1,198 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Installation
============

First it is always a good idea to update ``pip`` to the latest version with :command:`pip`::

    python -m pip install --upgrade pip

To use it as a simple Nextcloud client install it without any additional dependencies with :command:`pip`::

    python -m pip install --upgrade nc_py_api

To use in the Nextcloud Application mode install it with additional ``app`` dependencies with :command:`pip`::

    python -m pip install --upgrade "nc_py_api[app]"

To use **Calendar API** just add **calendar** dependency, and command will look like this :command:`pip`::

    python -m pip install --upgrade "nc_py_api[app,calendar]"

To join the development of **nc_py_api** api install development dependencies with :command:`pip`::

    python -m pip install --upgrade "nc_py_api[dev]"

Or install last dev-version from GitHub with :command:`pip`::

    python -m pip install --upgrade "nc_py_api[dev] @ git+https://github.com/cloud-py-api/nc_py_api"

Congratulations, the next chapter :ref:`first-steps` awaits.

.. note::
    If you have any installation or building questions, you can ask them in the discussions or create a issue
    and we will do our best to help you.