Skip to main content

SDK Installation

ArconQ Python SDK is hosted on a private Nexus and not in the global pypi repository. Therefore the nexus url has to be added to your preferred package installation system.

Using Poetry​

In your Poetry project open the pyproject.toml file and put there the following configuration.

[[tool.poetry.source]]
name = "nexus"
url = "https://nexus.macrix.eu/repository/arq-pypi/simple"
priority = "supplemental"

[tool.poetry.dependencies]
arconq-sdk = {version = "^1.1.19", source = "nexus"}

Then run the standard set of commands.

poetry lock --no-update
poetry install --no-root

Using pip​

Adding repository to pip configuration​

You can add our repository to the pip config. This way the --extra-index-url flag can be omitted when running the installation commands.

You can do it by either editing the pip.ini which is located by default in %appdata%\pip\pip.ini

[global]
extra-index-url = https://nexus.macrix.eu/repository/arq-pypi/simple

If you can't find the mentioned file, run the following command.

pip config set global.extra-index-url https://nexus.macrix.eu/repository/arq-pypi/simple

Installation and updating​

# newest stable version
pip install arconq-sdk

# specifying a version
pip install arconq-sdk==1.1.19

# newest pre release version
pip install arconq-sdk --pre

# updating
pip install arconq-sdk --upgrade

If the step with adding the repository url to pip configuration was skipped the repository url must be added manually each time you run a command. Example:

pip install arconq-sdk --extra-index-url https://nexus.macrix.eu/repository/arq-pypi/simple