Skip to content

Getting Started with Marmara Connector Development

Rumeysa Yilmaz edited this page Sep 24, 2021 · 17 revisions

Preparing the Development Environment

Prerequisites

  • PYTHON3 -> python3.6 is needed for fbs packaging
  • PyQt5
  • QT Designer
  • pip library with latest version

Linux

Make sure that the OS is up to date and upgraded:

sudo apt-get update
sudo apt-get upgrade

Install tools required to build dependencies:

sudo apt install git python3 python3-pip python3-venv

Clone the repository to a desired location on the local machine:

git clone https://github.com/marmarachain/marmara-connector.git

For a system-wide PYQT5 and Designer Installation issue the following commands in the terminal:

pip3 install pyqt5==5.9.2
sudo apt-get install qttools5-dev-tools
sudo apt-get install python3-pyqt5
sudo apt-get install pyqt5-dev-tools

To work with a virtual environment on the project, issue the following commands outside the working directory of the project:

python3 -m venv venv
source venv/bin/activate
pip install pip==21.2.4
pip install -r requirement

In order to run the project, run mainApp.py under /src/main/python/ directory:

python3 mainApp.py

Windows

Install the following tools required to build dependencies:

  • git python3 python3-pip python3-venv

To install QT5 Designer:

Install the latest version of "pyqt5-tools" using:

 pip install pyqt5-tools --pre

The "designer.exe" will be installed in ...Lib\site-packages\qt5_applications\Qt\bin.

Clone the repository to a desired location on the local machine:

git clone https://github.com/marmarachain/marmara-connector.git

Change directory to marmara-connector. Create a virtual environment in the current directory:

python3 -m venv venv

Activate the virtual environment:

call venv\scripts\activate.bat

Continue the following steps while the virtual environment is active.

Install the required libraries:

pip install fbs PyQt5==5.9.2
pip install pip==21.0.1
pip install -r requirement

Resources

  • To setup the Windows OS environment with different python versions, check out here