Difference between revisions of "Running a development version of Gramps"

From Gramps
Jump to: navigation, search
m (de-tab a single line)
(Preparation)
 
(35 intermediate revisions by 12 users not shown)
Line 1: Line 1:
The following describes one possible scenario for getting the latest development version of Gramps running:
+
== Preparation ==
 +
* These instructions assume you have installed a recent version of Ubuntu, or Linux Mint(which is Ubuntu based).
  
* install a recent version of Ubuntu (eg. 7.04) or some other linux distribution. Here we will assume Ubuntu and give the install commnds (apt-get) for that distribution
+
* Install a text editor if you plan on modifying the Gramps source. You can use any text editor such as gedit, kate, or sourcenav (<tt>sudo apt-get install sourcenav</tt>), erik4, SPE, or [http://www.eclipse.org Eclipse] with the python plugin. Instructions on [[Development using Eclipse and Pydev|installing and configuring Eclipse for Gramps development]].  Follow the [[Programming Guidelines|programming guidelines for Gramps]].
: (Beyond the scope of this article, but VirtualBox and VMWare provide a great and relatively easy solution to getting an independant and/or clean build environment.)
+
 
* install some basic build tools
+
* [[Brief_introduction_to_Git#Obtaining_a_copy_of_the_Gramps_repository|Clone the Gramps repository]]
sudo apt-get build-essential
+
 
* install a text editor if you plan on modifying the Gramps source. You can use Gedit, kate, or dedicated software like sourcenav (<tt>sudo apt-get sourcenav</tt>), erik4, SPE or even Eclipse with python plugin. Follow the [[Programming Guidelines]].
+
== Gramps 4.0 and the master branch ==
* create a directory for the Gramps source
+
{{man note|Note|The steps in this section have been tested with Ubuntu 14.04}}
cd ~
+
{{man warn|1=warning|2=Do not open your existing databases with the master branch, it might destroy your data, and will make it impossible to use the data in the stable version {{stable_branch}}. To try it out, export your database to a gramps xml file, eg <code>test_master.gramps</code>, create a new family tree in the master branch, and import this xml file.}}
  mkdir gramps
+
 
  cd gramps</pre>
+
For the internationalization code to work, you need to have the translation tools.
* get the latest copy of GRAMPS
+
 
  sudo apt-get subversion
+
On Debian, just run (as root) - ('''Only if Debian installs Gramps 4.0+ as Gramps version!):
  svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk
+
apt-get build-dep gramps
* get ready to build GRAMPS
+
 
cd trunk
+
On Fedora 8 - 10 (Fedora is up to version 17 now so does this still apply?), you will need:
 +
yum install intltool gnome-doc-utils gettext git-core rcs
 +
 
 +
=== Build ===
 +
Now go into the top-level directory and type(earlier versions of Gramps used python 2 and from Gramps 4.2.x and newer only python 3 so substitute as required eg: python3):
 +
 
 +
python setup.py build
 +
 
 +
{{man warn|1=Warning|2=Do not install the development version if you don't know how to version python modules. That is, do '''not''' type {{man label|sudo python setup.py install}}. }}
 +
 
 +
=== Run ===
 +
==== Option 0: run from source repo ====
 +
From Gramps 4.2.x and master in the top-level directory you only need to type (this assumes your default python is python3):
 +
 
 +
  python Gramps.py
 +
 
 +
==== Option 1: run from source repo ====
 +
For Gramps 4.1.x and earlier (You can use either python or python3 substitute as necessary ):
 +
 
 +
Here, we use the code in working directory to run Gramps. This means that compiled python files will be stored there. This is not ideal, but the easiest way to develop Gramps, as changes are immediately picked up by the code.
 +
 
 +
Copy the const.py file created in build to your source directory if you want to use your source directory to work with Gramps:
 +
  cp build/lib.linux-$(uname -m)-2.7/gramps/gen/const.py gramps/gen/const.py
 +
  python Gramps.py
 +
 
 +
''Note'': the <code>lib.linux-$(uname -m)-2.7</code> folder name vary depending on your system (i686 or x86_64).
 +
 
 +
That is it. If you installed some dependencies of Gramps in non-default positions, you need to indicate with PYTHONPATH where they can be found, and with LD_LIBRARY_PATH where link libraries can be found. Eg, if you install GTK and spell checking from source too, you will need something like:
 +
  PYTHONPATH=/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python Gramps.py
 +
 
 +
==== Option 2: use the build code ====
 +
Here, we use the code build in <code>trunk/build</code> directory to run Gramps. For compiled programs this is the only way, but for Gramps nothing is compiled. It is not bad however to keep your code separated from your execution, as deleting the build directory is easy. After a code change in your source, you then need to run however <code>python setup.py</code> again to update the build direcotry. To run Gramps from build, do
 +
  cd trunk/build/lib.linux-$(uname -m)-2.7/
 +
  python -c 'from gramps.grampsapp import main; main()'
 +
 
 +
Again, it might be needed to set with PYTHONPATH where dependencies can be found, and with LD_LIBRARY_PATH link libraries, see option 1.
 +
 
 +
If you point your PYTHONPATH to the build directory, you can actually run Gramps from a random directory. Like this:
 +
 
 +
cd
 +
  PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python -c 'from gramps.grampsapp import main; main()'
 +
 
 +
So, more general:
 +
cd
 +
  PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib  python -c 'from gramps.grampsapp import main; main()'
 +
 
 +
If the build directory is in your PYTHONPATH, you can also just execute the grampsapp.py module. So this will work too:
 +
cd ~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/gramps
 +
PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python grampsapp.py
 +
 
 +
or again more generally
 +
PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python grampsapp.py
 +
 
 +
{{man note|Note using grampsapp.py works|all imports in Gramps have been converted to relative or absolute imports. This conversion was finished at the end of 2012.}}
 +
 
 +
{{man note|1=Known Problems|2=Some problems are due to the migration from GTK2 to GTK3: [[GEPS_029:_GTK3-GObject_introspection_Conversion#Problems|list of known problems]]}}
 +
 
 +
== Gramps 3.4 and before ==
 +
{{man note|Note|The steps in this section have been tested with Ubuntu 7.04, 7.10, 8.04, 10.04, 10.10 and 12.10 and Mint 14}}
 +
 
 +
* Install the tools we will need:
 +
sudo apt-get install build-essential gnome-common libglib2.0-dev git-core gettext
 +
 
 +
=== Build ===
 +
* Get ready to build Gramps:
 +
The old versions of Gramps use autotools, so you need to run:
 
  ./autogen.sh
 
  ./autogen.sh
* if you get a failure about gnome-common, install it:
+
 
sudo apt-get install gnome-common
+
* Build Gramps:
./autogen.sh
 
* if you get a failure about glib-gettext.m4, install it:
 
sudo apt-get install libglib2.0-dev
 
./autogen.sh
 
* build GRAMPS
 
 
  make
 
  make
* run Gramps
+
 
  python2.5 src/gramps.py
+
=== Run ===
 +
* Run Gramps:
 +
  python src/gramps.py
  
 
At this point, any time you want to update to the latest version of Gramps, simply run:
 
At this point, any time you want to update to the latest version of Gramps, simply run:
  cd ~/gramps/trunk
+
  git pull --rebase
svn update
+
python src/gramps.py
python2.5 src/gramps.py
+
 
 +
If some of the Gramps constants have changed and you obtain an error in const.py, rerun the commands <tt>autogen.sh</tt> and <tt>make</tt>.
 +
 
 +
==See also==
 +
* [[Gramps for Windows with MSYS2]]
  
It might happen constants have been changed, and you obtain an error on the const.py module. In that case, return <tt>autogen.sh</tt> and the <tt>make</tt> command.
 
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 23:36, 13 January 2018

Preparation

  • These instructions assume you have installed a recent version of Ubuntu, or Linux Mint(which is Ubuntu based).

Gramps 4.0 and the master branch

Gramps-notes.png
Note

The steps in this section have been tested with Ubuntu 14.04

Gnome-important.png
warning

Do not open your existing databases with the master branch, it might destroy your data, and will make it impossible to use the data in the stable version 51. To try it out, export your database to a gramps xml file, eg test_master.gramps, create a new family tree in the master branch, and import this xml file.

For the internationalization code to work, you need to have the translation tools.

On Debian, just run (as root) - (Only if Debian installs Gramps 4.0+ as Gramps version!):

apt-get build-dep gramps

On Fedora 8 - 10 (Fedora is up to version 17 now so does this still apply?), you will need:

yum install intltool gnome-doc-utils gettext git-core rcs

Build

Now go into the top-level directory and type(earlier versions of Gramps used python 2 and from Gramps 4.2.x and newer only python 3 so substitute as required eg: python3):

python setup.py build
Gnome-important.png
Warning

Do not install the development version if you don't know how to version python modules. That is, do not type sudo python setup.py install.

Run

Option 0: run from source repo

From Gramps 4.2.x and master in the top-level directory you only need to type (this assumes your default python is python3):

 python Gramps.py

Option 1: run from source repo

For Gramps 4.1.x and earlier (You can use either python or python3 substitute as necessary ):

Here, we use the code in working directory to run Gramps. This means that compiled python files will be stored there. This is not ideal, but the easiest way to develop Gramps, as changes are immediately picked up by the code.

Copy the const.py file created in build to your source directory if you want to use your source directory to work with Gramps:

cp build/lib.linux-$(uname -m)-2.7/gramps/gen/const.py gramps/gen/const.py
python Gramps.py

Note: the lib.linux-$(uname -m)-2.7 folder name vary depending on your system (i686 or x86_64).

That is it. If you installed some dependencies of Gramps in non-default positions, you need to indicate with PYTHONPATH where they can be found, and with LD_LIBRARY_PATH where link libraries can be found. Eg, if you install GTK and spell checking from source too, you will need something like:

 PYTHONPATH=/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python Gramps.py

Option 2: use the build code

Here, we use the code build in trunk/build directory to run Gramps. For compiled programs this is the only way, but for Gramps nothing is compiled. It is not bad however to keep your code separated from your execution, as deleting the build directory is easy. After a code change in your source, you then need to run however python setup.py again to update the build direcotry. To run Gramps from build, do

 cd trunk/build/lib.linux-$(uname -m)-2.7/
 python -c 'from gramps.grampsapp import main; main()'

Again, it might be needed to set with PYTHONPATH where dependencies can be found, and with LD_LIBRARY_PATH link libraries, see option 1.

If you point your PYTHONPATH to the build directory, you can actually run Gramps from a random directory. Like this:

cd
PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python -c 'from gramps.grampsapp import main; main()'

So, more general:

cd
PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib  python -c 'from gramps.grampsapp import main; main()'

If the build directory is in your PYTHONPATH, you can also just execute the grampsapp.py module. So this will work too:

cd ~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/gramps
PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python grampsapp.py

or again more generally

PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python grampsapp.py
Gramps-notes.png
Note using grampsapp.py works

all imports in Gramps have been converted to relative or absolute imports. This conversion was finished at the end of 2012.

Gramps-notes.png
Known Problems

Some problems are due to the migration from GTK2 to GTK3: list of known problems

Gramps 3.4 and before

Gramps-notes.png
Note

The steps in this section have been tested with Ubuntu 7.04, 7.10, 8.04, 10.04, 10.10 and 12.10 and Mint 14

  • Install the tools we will need:
sudo apt-get install build-essential gnome-common libglib2.0-dev git-core gettext

Build

  • Get ready to build Gramps:

The old versions of Gramps use autotools, so you need to run:

./autogen.sh
  • Build Gramps:
make

Run

  • Run Gramps:
python src/gramps.py

At this point, any time you want to update to the latest version of Gramps, simply run:

git pull --rebase
python src/gramps.py

If some of the Gramps constants have changed and you obtain an error in const.py, rerun the commands autogen.sh and make.

See also