English

Building and running Codimension from source

Introduction

The existing Codimension codebase is split between tree repositories:

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

Prerequisites

Make sure you have python 2.7 installed and it runs by default:

$ python --version

The python version must be 2.7.X

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.

Control Flow Parser

Get the latest Python 2 release code from GitHub, build the module, and install it for the current user:

Note: the master branch now has the code for Python 3. So please use the Python 2 release branch code (the latest Python 2 release is 1.0.1).

$ cd
$ wget https://github.com/SergeySatskiy/cdm-flowparser/archive/v1.0.1.tar.gz
$ gunzip v1.0.1.tar.gz
$ tar -xf v1.0.1.tar
$ cd cdm-flowparser-1.0.1/
$ make
$ make localinstall
$ make check

The unit tests must pass

Brief Python Parser

Get the latest Python 2 release code from GitHub, build the module, and install it for the current user:

Note: the master branch now has the code for Python 3. So please use the Python 2 release branch code (the latest Python 2 release is 2.0.1).

$ cd
$ wget https://github.com/SergeySatskiy/cdm-pythonparser/archive/v2.0.1.tar.gz
$ gunzip v2.0.1.tar.gz
$ tar -xf v2.0.1.tar
$ cd cdm-pythonparser-2.0.1/
$ make
$ make localinstall
$ make check

The unit tests must pass

Codimension IDE

Get the latest IDE source code from GitHub:

Note: the master branch has the code for Python 2. Python 3 development branch is called p3. When porting is finished the master branch will contain Python 3 code.

$ git clone https://github.com/SergeySatskiy/codimension.git

Create a symbolic link:

$ cd ~/codimension/src
$ ln -s ../thirdparty thirdparty

Install the packages the IDE depends on. Here is a list of packages for Ubuntu:

Run codimension:

$ ~/codimension/src/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:

Setup Codimension plugins. At the moment there are two plugins available: a garbage collector plugin and an SVN plugin. To setup the plugins follow the steps below:

Contacts

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