pts-fault-injection 0.0.3

Fault Injection box Diagnostics package Diagnostic Package

PTS-Fault-Injection-box

Creates an interface to the Fault injection box in the BMS FKT

Installation

The following instruction will enable the user to properly close the repository and branch out to make their changes

Clone repository

cd <path-to-directory>
git clone [e-mail]:pass-testing-solutions/pts-fault-injection-box.git
cd pts-fault-injection-box/
git pull origin main
git checkout -b <your-new-branch>  # Please follow the branch naming convention as mentioned in the coding guidelines

Virtual environment on MacOS

1. Virtualenvwrapper

You can install virtualenv and virtualenvwrapper with:

pip3 install virtualenv
pip3 install virtualenvwrapper
mkdir ~/.virtualenvs
# Might need to query where the virtualenv and virtualenvwrapper.sh are
which virtualenv
which virtualenvwrapper.sh
which python3

Add these lines in the ~/.zshrc file

# Setting PATH for Python 3 installed by brew
export PATH=<path-to-your-python3>:$PATH

# Configuration for virtualenv
export WORKON_HOME=$HOME/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=<path-to-your-python3>
export VIRTUALENVWRAPPER_VIRTUALENV=<path-to-your-virtualenv>
source <path-to-your-virtualenvwrapper.sh>

source $ZSH/oh-my-zsh.sh

Make sure to save these changes in your file and close your terminal for them to take effect. Doing the previous few steps in the installation of the Virtualenvwrapper only needs to be done once. After a Virtualenv and Virtualenvwrapper are set up, all you need to do to create a new virtual environment for a new project is to follow the following steps:

You can create a virtual environment by simply typing -

mkvirtualenv <name-of-your-virtual-env>
cd <your-git-repository>
workon <name-of-your-virtual-env>
deactivate <name-of-your-virtual-env>    # to deactivate the venv

To add the correct interpreter for your repository on PyCharm:

- PyCharm IDE > Preferences > Project > Python Interpreter
- Select the 'Add' button for interpreters
- Choose the 'Existing environments' in 'Virtualenv'
- Add the python3 file from /bin/ of your venv folder
E.g. - .virtualenvs/demo_repo_venv/bin/python3

After setting up the venv for the repo please install all the requirements and allow some time for the IDE to do indexing. If your repository has a requirements.txt:

pip3 install -r requirements.txt

---

2. Pipenv

Install pipenv

pip3 install pipenv 
# or
brew install pipenv

pipenv shell         # will create a virtualenv for the project
pipenv install       # will install dependencies for the repo from the Pipfile and Pipfile.lock

# Install any further packages in this environment as

pipenv install rich  # rich is a python library to nicely print on terminal

Your pipenv environment will be in the ~./virtualenvs folder. Make sure to add the interpreter on your IDE if not automatically added by navigating to the virtualenv folder for your repo and selecting the correct python3 file from /bin/.

---

If your repository contains a Pipfile instead of a requirements.txt, the installation instructions will activate the pip virtual environment shell and install all the dependencies.

cd pts-fault-injection-box/
pipenv shell
pipenv install

Authors and Maintainers

Author:

        Shuparna Deb @shuparnadeb_pts

Maintainer:

        Julian Paß @julianpass
        Shuparna Deb @shuparnadeb_pts

License

License :: OSI Approved :: MIT License