navikt/PyARXaaS

Installing PyARXaaS
==================================

.. note:: PyARXaas requires python 3.6 and up. `Python download <https://www.python.org/downloads/>`_

PyARXaaS is available on PyPI
`PyPI link <https://pypi.org/project/pyARXaaS/>`_


Pip install
-----------

Open the command-line interface and write:

.. code-block:: bash

    pip install pyarxaas

(Optional) Setup virtual environment
------------------------------------
Mac/Linux

1. Create a new directory

.. code-block:: bash

    mkdir pyarxaas-project

2. Change currenct directory to 'pyarxaas-project'

.. code-block:: bash

    cd pyarxaas-project

3. Create a virtual environment

.. code-block:: bash

    python3 -m venv c:\path\to\myenv

4. activate the virtual environment

.. code-block:: bash

    source venv/bin/activate

Windows (Windows Powershell)

1. Create a new directory

.. code-block:: bash

    mkdir pyarxaas-project

2. Change currenct directory to 'pyarxaas-project'

.. code-block:: bash

    cd .\pyarxaas-project

3. Create a virtual environment

.. code-block:: bash

    python -m venv c:\path\to\myenv

4. activate the virtual environment

.. code-block:: bash

    .\Scripts\activate

Get the Source Code
-------------------

.. code-block:: bash

    git clone https://github.com/oslomet-arx-as-a-service/PyARXaaS.git