Getting started with Gramps development - Revision history

Patsyblefebre: Gramps

2013-01-26T06:18:09Z

Gramps

Patsyblefebre: http://en.wikipedia.org/wiki/Hacker_%28programmer_subculture%29

2013-01-24T22:20:20Z

http://en.wikipedia.org/wiki/Hacker_%28programmer_subculture%29

Patsyblefebre: Patsyblefebre moved page Getting started with GRAMPS development to Getting started with Gramps development: lowercase

2013-01-17T00:59:00Z

Patsyblefebre moved page Getting started with GRAMPS development to Getting started with Gramps development: lowercase

Patsyblefebre: Gramps

2013-01-17T00:58:41Z

Gramps

Patsyblefebre: /* Other */ '''

2013-01-03T02:12:37Z

‎Other: '''

Patsyblefebre: /* Install a text editor */ highlight

2013-01-03T02:11:47Z

‎Install a text editor: highlight

Patsyblefebre: move adding text editor to before downloading source etc more logical

2012-12-27T05:09:13Z

move adding text editor to before downloading source etc more logical

Patsyblefebre: /* VirtualBox */ y

2012-12-27T05:05:42Z

‎VirtualBox: y

Patsyblefebre: /* Run GRAMPS from the source */ include git

2012-12-27T05:04:00Z

‎Run GRAMPS from the source: include git

Patsyblefebre: /* Get the source tree */ mention GITs path

2012-12-27T05:00:15Z

‎Get the source tree: mention GITs path

@@ Line 10: / Line 10: @@
 {{man warn|Warning:|I highly recommend that you do not use your usual environment for developing Gramps. Definitely do '''not''' work on your main Gramps family tree. Doing so may result in data loss in your Gramps Family Tree !}}
-If you run your development version of Gramps as the usual user, it will show all your usual Gramps family trees, so loading one by mistake is possible and a bug may result in losing productive data.  To prevent this, you could use a [[GRAMPSHOME]] environment variable to create a separate folder for productive data, see [[Run GRAMPS from a portable drive]] for more information.
+If you run your development version of Gramps as the usual user, it will show all your usual Gramps family trees, so loading one by mistake is possible and a bug may result in losing productive data.  To prevent this, you could use a [[GRAMPSHOME]] environment variable to create a separate folder for productive data, see [[Run Gramps from a portable drive]] for more information.
 Here are some options you may choose to prevent this. If you have enough resources, I recommend using VirtualBox.

@@ Line 1: / Line 1: @@
 {{man warn|Warning:|This tutorial is work in progress. Feel free to help and modify it.}}
-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 aims to help you in your first [http://en.wikipedia.org/wiki/Hacker_%28programmer_subculture%29 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.

@@ Line 1: / Line 1: @@
 {{man warn|Warning:|This tutorial is work in progress. Feel free to help and modify it.}}
-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 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.
@@ Line 8: / Line 8: @@
 == Optional : set up a development environment ==
-{{man warn|Warning:|I highly recommend that you do not use your usual environment for developing GRAMPS. Definitely do '''not''' work on your main GRAMPS family tree. Doing so may result in data loss in your GRAMPS Family Tree !}}
+{{man warn|Warning:|I highly recommend that you do not use your usual environment for developing Gramps. Definitely do '''not''' work on your main Gramps family tree. Doing so may result in data loss in your Gramps Family Tree !}}
-If you run your development version of GRAMPS as the usual user, it will show all your usual GRAMPS family trees, so loading one by mistake is possible and a bug may result in losing productive data.  To prevent this, you could use a [[GRAMPSHOME]] environment variable to create a separate folder for productive data, see [[Run GRAMPS from a portable drive]] for more information.
+If you run your development version of Gramps as the usual user, it will show all your usual Gramps family trees, so loading one by mistake is possible and a bug may result in losing productive data.  To prevent this, you could use a [[GRAMPSHOME]] environment variable to create a separate folder for productive data, see [[Run GRAMPS from a portable drive]] for more information.
 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 open source 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 favorite Linux distribution and start hacking GRAMPS in a fully separated environment.
+[http://www.virtualbox.org/ VirtualBox] is an open source 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 favorite Linux distribution and start hacking Gramps in a fully separated environment.
 === Chroot ===
@@ Line 22: / Line 22: @@
 If you use Ubuntu, you can set up the chroot environment following these instructions:
 [https://help.ubuntu.com/community/BasicChroot Creating a basic Ubuntu chroot]
-If you use GRAMPS in a chroot jail with another Linux distribution, please add information here.
+If you use Gramps in a chroot jail with another Linux distribution, please add information here.
 You should then have a working chroot environment in /var/chroot (or whichever location you chose).
@@ Line 28: / Line 28: @@
   sudo chroot /var/chroot
 This means that within this directory, applications cannot access files without the chroot jail,
-i.e. your GRAMPS install within the directory cannot destroy another install of GRAMPS in your usual home directory.
+i.e. your Gramps install within the directory cannot destroy another install of Gramps in your usual home directory.
-From a shell within your chroot directory, just svn-checkout the GRAMPS trunk into the chroot folder as usual.
+From a shell within your chroot directory, just svn-checkout the Gramps trunk into the chroot folder as usual.
 Please note that before running the autogen-Script for generating makefiles, you may need to get some packages:
   apt-get install python intltool libglib2.0-dev gedit
@@ Line 72: / Line 72: @@
 First, you have to set the path to your python interpreter. Go in the menu "Window"->"Preferences...", then choose "Pydev"->"Interpreter - Python". With "new", you can create a link to "/usr/bin/python2.5". there you are.
-Next, you have to set up a pydev project. Go in the menu "File" -> "New" -> "Project", and choose a Pydev projet. Project name could be "GRAMPS trunk", uncheck "Use defaults" and choose "~/gramps-trunk" as the project directory. Project type is "Python 2.6", and then you can press "Finish". You are now ready to start coding !
+Next, you have to set up a pydev project. Go in the menu "File" -> "New" -> "Project", and choose a Pydev projet. Project name could be "Gramps trunk", uncheck "Use defaults" and choose "~/gramps-trunk" as the project directory. Project type is "Python 2.6", and then you can press "Finish". You are now ready to start coding !
 === pycharm ===
@@ Line 79: / Line 79: @@
 'Version Control » Update Project' automatically syncs up with the svn (which it picks up from the .svn directories, unlike Eclipse+pydev that dumbly shows the .svn directories for me and keeps complaining on things going out of sync).
-Some free software projects qualify for a Jetbrains free pycharm usage licences. We have applied for one to use in GRAMPS development, and currently GRAMPS has been awarded such a license -- as a consequence of the GRAMPS distribution terms (GPL). Here's what you should do to get a copy ('''and use it for GRAMPS development only, not for other work, under this license!'''), according to [[User:Bmcage|Benny]]:
+Some free software projects qualify for a Jetbrains free pycharm usage licences. We have applied for one to use in Gramps development, and currently Gramps has been awarded such a license -- as a consequence of the Gramps distribution terms (GPL). Here's what you should do to get a copy ('''and use it for Gramps development only, not for other work, under this license!'''), according to [[User:Bmcage|Benny]]:
 / be a gramps developer with commit rights to our repository
 / write [[User:BACbKA|Vassilii]] with your sourceforge login name and ask him for the license key
@@ Line 116: / Line 116: @@
 You can also use a graphical SVN manager like "kdesvn" or "SVN Workbench".
-'''This tutorial now assumes you have downloaded GRAMPS' trunk using SVN into "~/gramps-trunk" or using GIT into "~/Gramps". If not, you have to change this path when it is used below.'''
+'''This tutorial now assumes you have downloaded Gramps' trunk using SVN into "~/gramps-trunk" or using GIT into "~/Gramps". If not, you have to change this path when it is used below.'''
 {{man warn|Warning:|Let it be clear that the settings directory "~/.gramps/" is a '''different''' hidden directory in your home-dir. Do not store anything there.''}}
-== Run GRAMPS from the source ==
+== Run Gramps from the source ==
-To test that you did all well, you may want to run GRAMPS from your downloaded SVN tree or GIT tree. This is explained in the [[Brief introduction to SVN]] or [[Git]]; here are the quick steps:
+To test that you did all well, you may want to run Gramps from your downloaded SVN tree or GIT tree. This is explained in the [[Brief introduction to SVN]] or [[Git]]; here are the quick steps:
 ;Under SVN
   cd ~/gramps-trunk
@@ Line 220: / Line 220: @@
 === gramps/gen ===
 This is Gramps' core. It defines genealogy objects (Person, Place, Note...), database classes, generic plugins, and database access :
-* '''gramps/gen/db''' : GRAMPS Database Handling
+* '''gramps/gen/db''' : Gramps Database Handling
-* '''gramps/gen/lib''' : The core library of GRAMPS objects
+* '''gramps/gen/lib''' : The core library of Gramps objects
-* '''gramps/gen/proxy''' : Proxy class for the GRAMPS databases. This is a very powerful tool used to propose a filtered view of the database : Objects which are not marked private, (not) living persons...
+* '''gramps/gen/proxy''' : Proxy class for the Gramps databases. This is a very powerful tool used to propose a filtered view of the database : Objects which are not marked private, (not) living persons...
-* '''gramps/gen/utils''' : Common utilities for GRAMPS code (progess monitor dialog, database utilities, callbacks between UI and database code)
+* '''gramps/gen/utils''' : Common utilities for Gramps code (progess monitor dialog, database utilities, callbacks between UI and database code)
 === other ===

@@ Line 107: / Line 107: @@
 [http://kate-editor.org/ Kate] works well as a general editor for Python. It also recognizes key words of Python and marks them in colours. Kate is a Linux KDE desktop program.  Of course, it also works on gnome installations.
-"Idle" is a handy simple editor that takes advantage of the interpreter features of Python. Often Idle comes with Python packages. Idle works well in Linux and other OS's, including the "dominant OS". If you install Windows version of Python, you will probably install from the same package Idle. One feature of Idle tends to confuse newcomers: Idle main window is NOT used for program writing, but for displaying the results. Notice that there is a Python tutorial, automagically installed with Idle on a Windows box. It is worth noting that the Tutorial gives quite extensive introduction into Python and is authored by the originator of Python: Guido van Rossum.
+'''Idle''' is a handy simple editor that takes advantage of the interpreter features of Python. Often Idle comes with Python packages. Idle works well in Linux and other OS's, including the "dominant OS". If you install Windows version of Python, you will probably install from the same package Idle. One feature of Idle tends to confuse newcomers: Idle main window is NOT used for program writing, but for displaying the results. Notice that there is a Python tutorial, automagically installed with Idle on a Windows box. It is worth noting that the Tutorial gives quite extensive introduction into Python and is authored by the originator of Python: Guido van Rossum.
 (If you have a favourite Editor and want to share it : describe how to set it up here.)

@@ Line 63: / Line 63: @@
 == Install a text editor ==
-The following is in alphabetic order. Choose the one you like. Whichever editor you use, make sure that it is set up so that the indent level is 4 spaces. Do not use the Tab character to indent.
+;Whichever editor you use, make sure that it is set up so that the indent level is 4 spaces. Do not use the Tab character to indent.
 === Eclipse + pydev ===

@@ Line 57: / Line 57: @@
 === None of above ===
 You have been warned! At a minimum name your test family trees 'a_test_name'. By starting with 'a_test' they show at the top of the family tree manager, and the test makes it clear what they are for.
 == Mac OS X ==
 In order to develop (or even use) Gramps on an Apple Macintosh, you must first install all of the prerequisite libraries and their headers. There are three choices for this [http://live.gnome.org/Gtk%2BOSX Gtk-OSX], [http://www.macports.org MacPorts], or [http://www.finkproject.org Fink]. Full instructions for building Gramps for each is provided here: [[Mac OS X:Build from source:Application package]], [[Mac OS X:Build from source:MacPorts]], or [[Mac OS X:Build from source:fink]].
 The last only works with X11, which is no longer included in OS X but can be installed separately. MacPorts can be built with/for either X11 or OS X's native Quartz graphics backend, and Gtk-OSX is exclusively for Quartz.
 == Install a text editor ==
@@ Line 119: / Line 108: @@
 (If you have a favourite Editor and want to share it : describe how to set it up here.)
 == Run GRAMPS from the source ==
@@ Line 238: / Line 236: @@
 * [http://www.gramps-project.org/docs/ API Code Documentation] - Gramps v3.3.0
 * [[Devhelp]]
 [[Category:Developers/Tutorials]]
-[[Category:Developers/General]]
+[[Category:Developers/General|G]]

@@ Line 121: / Line 121: @@
 == Run GRAMPS from the source ==
-To test that you did all well, you may want to run GRAMPS from your downloaded svn tree. This is explained in the [[Brief introduction to SVN]] but here are the quick steps :
+To test that you did all well, you may want to run GRAMPS from your downloaded SVN tree or GIT tree. This is explained in the [[Brief introduction to SVN]] or [[Git]]; here are the quick steps:
   cd ~/gramps-trunk
   python setup.py build
-For the internationalization piece to work, you need to have the translation tools. You obviously also need subversion and friends. On Debian, just run (as root) - ('''Only if Debian installs Gramps 4.0+ as Gramps version!):
+;Under GIT
   apt-get build-dep gramps