Difference between revisions of "Getting started with Gramps development"

From Gramps
Jump to: navigation, search
(Page creation)
 
(Development environment)
Line 1: Line 1:
 
 
[[Category:Developers/Tutorials]][[Category:Developers/General]]
 
[[Category:Developers/Tutorials]][[Category:Developers/General]]
  
 
'''Warning : this tutorial is work under progress. Feel free to help and modify it'''
 
'''Warning : this tutorial is work under progress. Feel free to help and modify it'''
 +
  
 
= Introduction =
 
= Introduction =
Line 10: Line 10:
  
 
= Set up your environment =
 
= Set up your environment =
== Optional : use a virtual machine or development ==
+
== Optional : set up a development environment ==
 +
I highly recommend that you do not use your usual environment for developing GRAMPS. Doing so may result in data loss in your GRAMPS database !
 +
If you run your development version of GRAMPS as you usual user, it will access to your usual GRAMPS database and a bug may result in losing productive data. Here are some options you may choose to prevent this. If you have enough resources, I recommend using VirtualBox.
 +
=== VirtualBox ===
 +
[[http://www.virtualbox.org/|VirtualBox]] is an opensource virtualisation solution. Install it, run it and you have a virtual PC in your PC. Network connection works out of the box without extra configuration needed. Install your favourite Linux distribution and start hacking GRAMPS in a fully separated environment.
 +
=== chroot ===
 +
You may also use a chroot to result in a similar separation as virtualbox. If you use a chroot for developping GRAMPS, please add informations here.
 +
=== another user ===
 +
You may also simply do you development as another user, so you won't access to your usual ~/.gramps database when testing.
 +
 
 
== Get the source tree ==
 
== Get the source tree ==
 
To get the source tree, you will need SVN. Please have a look at the dedicated tutorial [[Brief introduction to SVN]]
 
To get the source tree, you will need SVN. Please have a look at the dedicated tutorial [[Brief introduction to SVN]]
Line 17: Line 26:
 
=== Geany ===
 
=== Geany ===
 
=== PyPE ==
 
=== PyPE ==
 +
 +
== Run GRAMPS from the source ==
  
 
= Browse the source code =
 
= Browse the source code =
 
== data ==
 
== data ==
 
== src ==
 
== src ==

Revision as of 15:31, 30 August 2008


Warning : this tutorial is work under progress. Feel free to help and modify it


Introduction

This tutorial aims to help you in your first hacking of GRAMPS. It will help you setting up a development environment and explain where to find the files you need.

This tutorial assumes that you are using GNU/Linux (but it might help under another OS) and that you know the basics of Python programming language.

Set up your environment

Optional : set up a development environment

I highly recommend that you do not use your usual environment for developing GRAMPS. Doing so may result in data loss in your GRAMPS database ! If you run your development version of GRAMPS as you usual user, it will access to your usual GRAMPS database and a bug may result in losing productive data. Here are some options you may choose to prevent this. If you have enough resources, I recommend using VirtualBox.

VirtualBox

[[1]] is an opensource virtualisation solution. Install it, run it and you have a virtual PC in your PC. Network connection works out of the box without extra configuration needed. Install your favourite Linux distribution and start hacking GRAMPS in a fully separated environment.

chroot

You may also use a chroot to result in a similar separation as virtualbox. If you use a chroot for developping GRAMPS, please add informations here.

another user

You may also simply do you development as another user, so you won't access to your usual ~/.gramps database when testing.

Get the source tree

To get the source tree, you will need SVN. Please have a look at the dedicated tutorial Brief introduction to SVN

Install an Edior

Eclispe + pydev

Geany

= PyPE

Run GRAMPS from the source

Browse the source code

data

src