English

Building and Running Codimension from Sources

Introduction

The existing Codimension codebase is split between tree repositories:

To run Codimension from source you need to get the source code of all three components, build two Python extension modules (C/C++ compiler required), install them and then run the IDE. The instructions below describe the whole process with the following assumptions:

Prerequisites

Make sure you have a gcc compiler installed.

Make sure you have your Python version development package installed. The modules use the python header files. For example, on Ubuntu you would need the python-dev package installed.


Virtual Environment

Create a Python 3 virtual environment, e.g. (for Ubuntu 17.10):

$ cd
$ virtualenv -p python3 venvp3
$ source ~/venvp3/bin/activate
(venvp3) $ python --version
Python 3.6.3

The Python version should be 3.5.x or 3.6.x. (The 3.4.x version should work as well but it was not tested extensively.)

On some systems the wheel package needs to be installed first:

(venvp3) $ pip install wheel

Control Flow Parser

Clone the latest code from GitHub, build the module and install it in the virtual environment:

(venvp3) $ cd
(venvp3) $ git clone https://github.com/SergeySatskiy/cdm-flowparser.git
(venvp3) $ cd cdm-flowparser
(venvp3) $ python setup.py develop
(venvp3) $ make check

The last make check command will run the unit tests and all of them must pass.


Brief Python Parser

Clone the latest code from GitHub, build the module and install it in the virtual environment:

(venvp3) $ cd
(venvp3) $ git clone https://github.com/SergeySatskiy/cdm-pythonparser.git
(venvp3) $ cd cdm-pythonparser
(venvp3) $ python setup.py develop
(venvp3) $ make check

The last make check command will run the unit tests and all of them must pass.


Codimension IDE

By some reasons a few dependencies are failed to be installed during the typical python setup.py develop however they work just fine if pip is used. So, first install them explicitly:

(venvp3) $ pip install PyQt5
(venvp3) $ pip install cdmgcplugin

Now clone the latest code from GitHub and install it in the virtual environment:

(venvp3) $ cd
(venvp3) $ git clone https://github.com/SergeySatskiy/codimension.git
(venvp3) $ cd codimension
(venvp3) $ python setup.py develop

Run codimension:

(venvp3) $ codimension &

Optional steps

Install (if needed) and select a monospace font. Many developers find Ubuntu Mono font very suitable. To make the font available for Codimension follow the steps below:


Contacts

If you have any questions about running Codimension from a git clone please direct them to Sergey Satskiy.