refactor: granularity in the installation

.github/workflows/codecov.yml

@@ -36,7 +36,7 @@ jobs:
 
       # Runs the preparation
       - name: Prepare working environement
-        run: poetry install
+        run: poetry install --all-extras
 
       # Runs the test
       - name: Run unittests

Jenkinsfile

@@ -32,7 +32,7 @@ pipeline
                 checkout scm
                 // TODO remove once new docker image is available
                 sh 'python3 -m pip install poetry'
-                sh 'poetry install'
+                sh 'poetry install --all-extras'
             }
         }
         stage('Format check')

README.md

@@ -33,14 +33,16 @@ The project will contain:
 ## Install ##
 
 ```bash
-pip install pykiso
+pip install pykiso # Core framework
+pip install pykiso[plugins] # For installing all plugins
+pip install pykiso[all] # For installing all what we have to offer
 ```
 
 [Poetry](https://python-poetry.org/) is more appropriate for developers as it automatically creates virtual environments.
 
 ```bash
 cd kiso-testing
-poetry install
+poetry install --all-extras
 poetry shell
 ```
 

docs/getting_started/getting_started.rst

@@ -15,7 +15,13 @@ Install
 
 .. code:: bash
 
-   pip install pykiso
+   pip install pykiso # Core framework
+   pip install pykiso[plugins] # To install all plugins
+   pip install pykiso[can] # To enable you to use CAN related plugins
+   pip install pykiso[debugger] # To enable you to use JLINK and else related plugins
+   pip install pykiso[instrument] # To enable you to use instrument control plugins
+
+   pip install pykiso[all] # To enable you to install everything we have to offer
 
 `Poetry <https://python-poetry.org/>`__ is more appropriate for
 developers as it automatically creates virtual environments.
@@ -24,7 +30,7 @@ developers as it automatically creates virtual environments.
 
    git clone https://github.com/eclipse/kiso-testing.git
    cd kiso-testing
-   poetry install
+   poetry install --all-extras
    poetry shell
 
 Usage

docs/getting_started/getting_started_dev.rst

@@ -15,7 +15,7 @@ Install
 
    git clone https://github.com/eclipse/kiso-testing.git
    cd kiso-testing
-   poetry install
+   poetry install --all-extras
    poetry shell
 
 Pre-Commit

pyproject.toml

@@ -41,21 +41,54 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.7"
 PyYAML = "^6.0"
-pylink-square = ">=0.12,<0.15"
-pyserial = "^3.0"
-python-can = {version = "^4.0.0", extras = ["pcan"]}
-PyVISA = "^1.12.0"
-PyVISA-py = "~0.5.3"
 robotframework = "3.2.2"
 unittest-xml-reporting = "^3.2.0"
 click = ">=7.0.0,<9.0.0"
-pykiso-python-uds = "~3.0.2"
 tabulate = ">=0.8.9,<0.10.0"
 Jinja2 = ">=2.11.0,<4.0.0"
 MarkupSafe = "~2.0.1" # Allow support for Jinja2 between 2.11 < x < 3
 importlib-metadata = {version = ">=4.12,<6.0", python = "<3.8"}
+pylink-square = {version = ">=0.12,<0.15", optional = true}
+pykiso-python-uds = {version = "~3.0.2", optional = true}
+pyserial = {version = "^3.0", optional = true}
+PyVISA = {version = "^1.12.0", optional = true}
+PyVISA-py = {version = "~0.5.3", optional = true}
+python-can = {version = "^4.0.0", optional = true, extras = ["pcan,vector"]}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.extras]
+plugins = [
+    "pylink-square",
+    "pykiso-python-uds",
+    "python-can",
+    "pyserial",
+    "PyVISA",
+    "PyVISA-py",
+]
+can = [
+    "pykiso-python-uds",
+    "python-can",
+]
+debugger = [
+    "pylink-square",
+]
+instrument = [
+    "PyVISA",
+    "PyVISA-py",
+]
+serial = [
+    "pyserial",
+]
+all = [
+    "pylink-square",
+    "pykiso-python-uds",
+    "python-can",
+    "pyserial",
+    "PyVISA",
+    "PyVISA-py",
+]
+
+
+[tool.poetry.group.dev.dependencies]
 black = "22.10.0"
 bump2version = "*"
 coverage = { version = "^6.5", extras = ["toml"] }
@@ -71,6 +104,7 @@ sphinx-rtd-theme = "*"
 sphinxcontrib-programoutput = "*"
 sphinx-autodoc-typehints = "*"
 
+
 [tool.poetry.scripts]
 pykiso = 'pykiso.cli:main'
 pykiso-tags = 'pykiso.tool.show_tag:main'

src/pykiso/lib/auxiliaries/udsaux/uds_auxiliary.py

@@ -25,8 +25,11 @@
 from pathlib import Path
 from typing import Iterator, List, Optional, Union
 
-import can
-from uds import IsoServices
+try:
+    import can
+    from uds import IsoServices
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[can]'")
 
 from pykiso.connector import CChannel
 

src/pykiso/lib/connectors/cc_pcan_can.py

@@ -24,9 +24,13 @@
 from pathlib import Path
 from typing import Dict, Union
 
-import can
-import can.bus
-import can.interfaces.pcan.basic as PCANBasic
+try:
+    import can
+    import can.bus
+    import can.interfaces.pcan.basic as PCANBasic
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[can]'")
+
 
 from pykiso import CChannel, Message
 

src/pykiso/lib/connectors/cc_rtt_segger.py

@@ -27,7 +27,11 @@
 from pathlib import Path
 from typing import Dict, Optional, Union
 
-import pylink
+try:
+    import pylink
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[debugger]'")
+
 
 from pykiso import connector
 from pykiso.message import Message

src/pykiso/lib/connectors/cc_serial.py

@@ -23,7 +23,11 @@
 from enum import Enum, IntEnum
 from typing import ByteString, Dict, Optional, Union
 
-import serial
+try:
+    import serial
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[serial]'")
+
 
 from pykiso import Message, connector
 

src/pykiso/lib/connectors/cc_socket_can/cc_socket_can.py

@@ -25,8 +25,12 @@
 from pathlib import Path
 from typing import Dict, Union
 
-import can
-import can.bus
+try:
+    import can
+    import can.bus
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[can]'")
+
 
 from pykiso import CChannel, Message
 from pykiso.lib.connectors.cc_socket_can.socketcan_to_trc import (

src/pykiso/lib/connectors/cc_socket_can/socketcan_to_trc.py

@@ -25,7 +25,11 @@
 import time
 from textwrap import dedent
 
-import can
+try:
+    import can
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[can]'")
+
 
 log = logging.getLogger(__name__)
 

src/pykiso/lib/connectors/cc_uart.py

@@ -22,7 +22,10 @@
 import struct
 import time
 
-import serial
+try:
+    import serial
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[serial]'")
 
 from pykiso import connector, message
 

src/pykiso/lib/connectors/cc_usb.py

@@ -21,7 +21,10 @@
 .. warning: Still under test
 """
 
-import serial
+try:
+    import serial
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[serial]'")
 
 from pykiso.lib.connectors import cc_uart
 

src/pykiso/lib/connectors/cc_vector_can.py

@@ -22,10 +22,14 @@
 import logging
 from typing import Dict, Union
 
-import can
-import can.bus
-import can.interfaces.vector
-from can.interfaces.vector.canlib import get_channel_configs
+try:
+    import can
+    import can.bus
+    import can.interfaces.vector
+    from can.interfaces.vector.canlib import get_channel_configs
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[can]'")
+
 
 from pykiso import CChannel, Message
 

src/pykiso/lib/connectors/cc_visa.py

@@ -22,7 +22,11 @@
 import abc
 import logging
 
-import pyvisa
+try:
+    import pyvisa
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[instrument]'")
+
 
 from pykiso import CChannel
 from pykiso.types import MsgType

src/pykiso/lib/connectors/flash_jlink.py

@@ -24,7 +24,11 @@
 import pathlib
 import typing
 
-import pylink
+try:
+    import pylink
+except ImportError as e:
+    raise ImportError(f"{e.name} dependency missing, consider installing pykiso with 'pip install pykiso[debugger]'")
+
 
 from pykiso import Flasher