Development

Operation-System Specific-Considerations


Windows

windows_logo.png

If your current operating system is Windows it is recommend to either get a Linux-like environment (e.g. extend the console with Cywing) or better get Wubi (Windows Ubuntu Installer) as a dual boot system. The latter one is very straightforward.

In order to set up a local development version of Denigma on Windows do the following steps:

  1. Install your Developer version of Denigma

    First we get GIT, the cat [http://msysgit.github.com/]. For instance from here [http://denigma.de/url/3q]. The installation will ask to choose:

    a) use Git Bash only
    b) run Git from windows command prompt
    c) run Git and included Unix tools from windows command prompt
    

    Select c).

    Then open the command prompt, navigate to a folder where the Project shall live and run the following command:

    git clone https://github.com/hevok/denigma
    
  2. Preparing Denigma Programming Environment

    i) Installing Python:

    Install Python at first if you haven not yet [http://www.python.org/]. We are going with latest version of Python 2 (i.e. 2.7.3), as Python 3 is not yet well established. Many libraries are still in stage 2. So with Python 3 you would have a much smaller application ecosystem.

    If you are on a 64bit machine install the following executable [http://www.python.org/ftp/python/2.7.3/python-2.7.3.amd64.msi] under preferentially C:\Python27\.

    ii) Set Environment Variables:

    Next step is to set the environment variables. For this follow: Start > Control Panel > Double click on System Icon System Properties. There under system variables edit PATH and include in the front the following string: C:\Python27\;C:\Python27\Scripts\.

    iii) Install PyCharm:

    Then install a Interactive Development Environment for Python and Django [http://www.denigma.de/tutorials/77/view/].

  3. Configuring Virtual Environment:

    Download the latest easy Installer for Windows that fits the installed Python version (e.g. the exe at the bottom of [http://pypi.python.org/pypi/setuptools]) and install it.

    If you are on a 64bit machine consider to download ez_setup.py, copy it to C:\Python27, navigate into this folder in the DOS prompt and install it by running python ez_setup.py [http://peak.telecommunity.com/dist/ez_setup.py].

    Open a new DOS prompt and run easy_install pip as well as pip install virtualenv.

    Finally, navigate to the Denigma Project folder and create a virtual environment:

    virtualenv env --system-site packages
                  OR
    python virtualenv.py env --system-site packages # only if virtualenv installation failed
    
    C:\dev\denigma\env\Scripts\activate
    
  4. Starting Denigma:

    Now its time to prepare Denigma for running. First install some prerequisites:

    Then install all the other required libraries:

    pip install -r denigma/requirements/project.txt
    
    python manage.py syncdb --all
    python manage.py migrate --fake
    python manage.py runserver
    

    Open localhost:8000 in the browser and it is accomplished.

  5. Modify Denigma:

    i) modify locally

    git add modified_file 
    git commit -m "Describe the change here"
    

    ii) upload you modification to the online Denigma

    git push
    
  6. Keep Denigma updated

    Regularly pull any Changes in Denigma source code:

    git pull
    

o

More on Wubi »

Mac

If you are on Mac OX this is fine as it is UNIX-based system also the instructions will be majorly for Linux. o

More on Unix »

Linux

tux.jpg

Linux is the most preferred system in which Denigma and the interaction with it can run. Denigma itself is currently in an Ubuntu environment implemented.

In order to set up Denigma locally just do the following (Ubuntu or at least a UNIX environment is recommended):

  1. Git in:

    Go to the GIT bootcamp (sign up if you haven't already): https://github.com/

    In brief on UNIX:

    $ sudo su # Get full control about your machine.
    $ apt-get install git # Get (g)it!
    

    Configure Git with your name and e-mail:

    $ git config --global user.name "FULL NAME"
    $ git config --global user.email email@address.com
    
  2. Fork Denigma:

    $ git clone https://github.com/hevok/denigma
    
  3. Get the Might to Create Virtual Environments:

    $ curl http://python-distribute.org/distribute_setup.py | python
    $ easy_install virtualenv
    $ cd denigma
    $ virtualenv env
    $ . env/bin/activate
    
  4. Prepare Environment:

    $ apt-get update
    $ apt-get install python-dev libmysqlclient-dev     # Latter is an optional database-backend
    $ apt-get install -y subversion
    $ pip install -r denigma/requirements/pre.txt       # Prerequisite
    $ pip install -r denigma/requirements/project.txt
    
  5. Start Denigma:

    $ ./manage.py syncdb --all
    $ ./manage.py migrate --fake
    $ ./manage.py runserver
    
  6. Change Denigma:

    $ git commit -am "Brief description of the change."
    $ git push origin master
    
  7. Keep Denigma Updated:

    $ git checkout master # Update to the latest version.
    $ git pull # Pull it from master.
    

o

More on Ubuntu »