aboutsummaryrefslogtreecommitdiffstats
path: root/docs/usage/installation.rst
blob: c324c96f89c4831a08a6e9ab4a38905e7987261d (plain)
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
############



Installing with pip
--------------------

.. code:: shell

    $ pip install onapsdk


Customize the configuration
---------------------------

You can customize the global settings of onapsdk by creating an environment
variable ONAP_PYTHON_SDK_SETTINGS and a file my_settings.py.

By default the global settings are retrieved from the file located in
src/onapsdk/configuration/global_settings.py. You can create your own customized
configuration file and reference it through the environement variable.
You can thus copy/paste the existing global_settings.py file, rename it as
my_settings.py, adapt it with your favorite editor and export the environnement
variable accordingly.

It can be useful to move from a nodeport to an an ingress based configuration
or test different API versions.

  .. code:: shell

      $ export ONAP_PYTHON_SDK_SETTINGS="onapsdk.configuration.my_settings"