Difference between revisions of "Run Gramps40 for Windows from source using Python 2.7.3"

Introduction

This page gives information how to run Gramps 4.0.x from source on a Windows system. After some trials there was the result to focus on 32 bit Python 2.7.3 (since July 2013 also 2.7.5) because of several issues related to Gtk and database connection. All steps were done by the author on Windows 7 64bit German. (There are first user experiences that the following also run for WinXP 32bit and Win8 )

There are some parts marked as "TODO ISSUE" because of known issues.

There are some parts marked as "TODO WORK" because it's not done yet done (work in progress).

 This is a work in progress... Nobody guarantees anything at all!Any comments and help (e.g. on wiki pages) are welcome.
 02.12.2013 Still under construction for Python 2.7.6 and GTK 3.10.2!!

Last update: 02.12.2013 (start to change the content for newer python and gtk versions)

Python

• Python 2.7 or greater, Python 3.2 or greater (python version cannot be mixed)

We use: Python 2.7.6 32 bit from http://www.python.org/getit/ (python-2.7.6.msi) for all examples assumed to be installed into "C:\Python27".
Comment: It's also possible to use Python 2.7.3 or 2.7.5 but always 32 bit (no experiences for 64 bit versions)
Comment: For Win7 user it's easier to don't use "C:\Program Files (x86)\..." because for every change somewhere in this folder one has to activate the administrator's rights again and again.

Gtk, pyobject

• GTK 3.0 or greater
• pygobject 3.3.2 or greater
• cairo, pango, pangocairo with instrospection bindings (the gi packages)
• librsvg2 (svg icon view)
• xdg-utils

With the help of an open source programmer we get this package (here again the authors personally thank for his good job supporting Gramps in this way - see there to know more about of his other work: http://opensourcepack.blogspot.de/2013/01/mypaint-and-pygi.html):

• All gtk binaries are included in the package pygi-aio-3.10.2-win32_rev7.7z and right placed.
• No need for processors having an instruction set SSSE3.
• For all examples it's assumed that the included Gtk binaries will be stored into "C:\Python27\Lib\site-packages\gtk" and it's also strongly assumed that this value will be added to the windows environment variable PATH!

Checking the state of the package can be done by:

• start Python (e. g.: C:\Python27>python)
• and than call the functions as follows. There should be the same results.
Python 2.7.6 (default, Nov 10 2013, 19:24:18) [MSC v.1500 32 bit (Intel)] on win
32
>>> from gi.repository import Gtk
>>> Gtk.get_major_version()
3L
>>> Gtk.get_minor_version()
10L
>>> Gtk.get_micro_version()
4L
>>> from gi.repository import GObject
>>> GObject.pygobject_version
(3, 10, 2)


ICU/PyICU

This package is a "must be".

• Copy all files from PYICU_py27_win32.zip\lib\site-packages to "C:\Python27\Lib\site-packages"
• Now we have to place the binaries from PYICU_py27_win32.zip\bin to a folder found by Python / Gramps:
• First Option: Somewhere on hard disc e.g. "C:\icu". In this case we have to add this path to the environment variable PATH.
• Second Option: Into the same folder as python.exe. That's a good solution for a package, because we don't need any changes for the environment variable PATH.

To check ICU/PyICU just try it in Python (don't forget the environment variable PATH):

Python 2.7.6 (default, Nov 10 2013, 19:24:18) [MSC v.1500 32 bit (Intel)] on win
32
>>> import icu
>>> print icu.ICU_VERSION
50.1.2
>>> print icu.VERSION
1.5


language-pack-gnome-xx

• Translation of GTK elements to your language, with xx your language code eg for Dutch you need language-pack-gnome-nl. The translation of the Gramps strings is included with the source code.

The necessary package related to our GTK package will be provided also by the programmer of the GTK package (see above).

osmgpsmap

==> osmgpsmap is an optional package even the README requires "strongly recommended".

• If you don't have osmgpsmap there will be no message during the start-up of Gramps about a missing osmgpsmap. The only thing is the missing Geographic view in Gramps.
• There is a warning from the provider of this package: "window resizing crashed". But it seems this doesn't happens for Gramps - may be in rare cases only.

GraphViz

• Enable creation of graphs using GraphViz engine.
• Without this no beautiful graphs can be created.
• Obtain it from: http://www.graphviz.org

Following the information on http://www.graphviz.org we get the current package graphviz-2.34.zip from http://www.graphviz.org/Download_windows.php.

For the examples we copy the complete content to "C:\Program Files (x86)\Graphviz2.34\".

To give Gramps the access to this software we have to add the directory of the related binaries to the PATH environment variable. But to prevent trouble with the used dll versions between GraphViz and Gramps it's strongly recommended to add this at the end of PATH

SET PATH=%PATH%;C:\Program Files (x86)\Graphviz2.34\bin


GraphViz will be used e. g. for any report in Reports --> Graphs. Without GraphViz there is only one output format "Graphvi File". If all is OK there are several output formats available (e. g. "PDF (Graphviz)", "JPEG image" etc.).

pyexiv2

24.02.2013: Will not be used any more, replaced by GExiv2

ghostscript ghostview

Optional packages

• Python / Gramps needs to know the folder where the binaries are stored (default: "C:\Program Files (x86)\gs\gs9.10\bin") by defining the environment variable PATH.
• As option it's possible to place the content of the binary folder (default: "C:\Program Files (x86)\gs\gs9.10\bin") into the same folder as python.exe to prevent any changes of the environment variable PATH.
• From http://pages.cs.wisc.edu/~ghost/gsview/get50.htm download and run gsv50w32.exe (e. g. into the default install folder: C:\Program Files (x86)\Ghostgum).
• Python / Gramps needs to know the folder where the binaries are stored (default: "C:\Program Files (x86)\Ghostgum\gsview") by defining the environment variable PATH.
Comment: This tool will be used to display .ps files as optional result of reports. So at least it's like e.g. any a .pdf viewer or .rtf viewer. It would be possible to include it into any Gramps package. But as normally nobody would include a .pdf viewer or .rtf viewer into a Gramps package I won't suggest to do that for a .ps viewer.

GExiv2

Is an optional package. 02.12.2013: GExiv2 is integrated part of the GTK3 package.

gtkspell

• Enable spell checking in the notes.
• Gtkspell depends on enchant.
• A version of gtkspell with gobject introspection is needed, so minimally version 3.0.0.

The basics to use a spell are already included in the here used GTK3 package. The only missed things are myspell dictionaries. These can be found:

• from http://wiki.openoffice.org/wiki/Dictionaries download the language packages of your choice. In some cases (e.g. for German) it's more difficult because one has to download a "OpenOffice.org 3.x Extensions" package. For German one will get via http://extensions.services.openoffice.org/project/dict-de_DE_frami the file dict-de_DE-frami_2012-06-17.oxt. Using a program like 7-Zip one will find the necessary files (de_DE_frami.aff and de_DE_frami.dic) in "dict-de_DE-frami_2012-06-17.oxt\de_DE_frami\".
• from e.g. the GrampsAOI3.4.2 package in "..\GrampsAIO32_3.4.2\share\enchant\myspell"

For our example all files *.aff *.dic have to be stored into "C:\Python27\Lib\site-packages\gtk\share\enchant\myspell".

TODO ISSUE/WORK There are still some issues using spell:

• Open the note editor having spell activated slows down the os extremely as longer as larger the text.
• The spell settings will not be stored.

rcs

--> will not be used
There is still the same issue as in Gramps 3.0.1 and later 3124.
Currently there is no special code like 'if win(): DON'T USE RCS'.
It seems to be working but the reload from an archived database doesn't run.
Finally it doesn't matter to install rcs.

It seems to be better in general to use the Gramps function "Make Backup..."
than to archive a bsddb database what means in detail also more an backup
than an archive. It could be a good idea to handle such backups in the db
open window like archives using rcs. (TODO WORK: add an feature request)


PIL

• Python Image Library is needed to convert non jpg images to jpg so as to include them in LaTeX output

ttf-freefont

Information from README: More font support in the reports

07.03.2013 TODO WORK: How to use for the Windows environment. It's assumed that the fonts should be added to the Graphviz environment, but not yet tested.

gir-webkit

• GObject introspection data of WebKit is required for the hidden view 'Htmlview', which allows websites to be opened in Gramps.
• Users can unhide the view in the plugin manager.
• A html renderer must be installed to use the view.
•  !! PACKAGERS, Test if on your distribution webkit and Gramps is stable. If you obtain crashes, patch src/plugins/view/htmlrenderer.py and src/plugins/view/geoview.gpr.py, so as to remove: from gi.repository import WebKit as webkit

07.03.2013: Webkit is an integrated part of the GTK3 package. But currently it runs for internal file addresses only. Any web address "http://..." crashes
TODO ISSUE: To have it run without any issue.

goocanvas2

• Required for the Graphview plugin

• 07.03.2013: From http://ftp.gnome.org/pub/GNOME/binaries/win32/goocanvas/2.0/ download goocanvas-2.0.1-win32.zip and store the goocanvas-2.0.1-win32.zip\bin\libgoocanvas-2.0-9.dll into a folder found by Gramps. For our example we use a own folder to be interdependent from any other changes: C:\Goocanvas.
• From the GrampsAIO32_3.4.2\lib\site-packages copy goocanvas.pyd into C:\Python27\Lib\site-packages (TODO WORK: Have a better place to download from.)

To use this one needs the Graphview add-on.
TODO ISSUE 07.03.2013: The Graphview is currently not stable!

Debug Environment

MinGW

TODO WORK: description

Eclipse

TODO WORK: description

dependency viewer

TODO WORK: description

Start Gramps 4.0

Get Gramps sources

For all examples it's assumed that the Gramps source (e.g. from the repository http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40) will be stored into "C:\Gramps4.0".

It's helpful to use a Subversion client for Windows to get these sources. Also if one gets sources only such a tool provides the possibility of history search and or compare and also to mark differences between the current version on the computer and the repository.

Prepare Setup

For all examples assumed to be installed to: "C:\Program Files (x86)\GnuWin32\bin" (The default path of the installer)

To run setup.py we need the translation tool msgfmt.exe having a proper version. The installer for poedit (http://sourceforge.net/projects/poedit/files/poedit/1.5/poedit-1.5.7-setup.exe/download) provides msgfmt.exe in version 0.18.1.0.

For all examples we assume poedit to be installed to: "C:\Program Files (x86)\Poedit" (The default path of the installer).

Run Setup Build

Running "setup.py build" generates necessary translation files (*.mo) and the const.py from const.py.in

Here is an example batch file to run this:


C:
cd C:\Gramps4.0
set path=C:\Python27;C:\Program Files (x86)\Poedit\bin;%path%
C:\Python27\python setup.py build
pause



The result should look like this:

running build
Compiling po\bg.po >> share/locale/bg/LC_MESSAGES.
Compiling po\ca.po >> share/locale/ca/LC_MESSAGES.
Compiling po\cs.po >> share/locale/cs/LC_MESSAGES.
Compiling po\da.po >> share/locale/da/LC_MESSAGES.
Compiling po\de.po >> share/locale/de/LC_MESSAGES.
Compiling po\el.po >> share/locale/el/LC_MESSAGES.
Compiling po\en_GB.po >> share/locale/en_GB/LC_MESSAGES.
Compiling po\es.po >> share/locale/es/LC_MESSAGES.
Compiling po\fi.po >> share/locale/fi/LC_MESSAGES.
Compiling po\fr.po >> share/locale/fr/LC_MESSAGES.
Compiling po\he.po >> share/locale/he/LC_MESSAGES.
Compiling po\hr.po >> share/locale/hr/LC_MESSAGES.
Compiling po\hu.po >> share/locale/hu/LC_MESSAGES.
Compiling po\it.po >> share/locale/it/LC_MESSAGES.
Compiling po\ja.po >> share/locale/ja/LC_MESSAGES.
Compiling po\lt.po >> share/locale/lt/LC_MESSAGES.
Compiling po\nb.po >> share/locale/nb/LC_MESSAGES.
Compiling po\nl.po >> share/locale/nl/LC_MESSAGES.
Compiling po\nn.po >> share/locale/nn/LC_MESSAGES.
Compiling po\pl.po >> share/locale/pl/LC_MESSAGES.
Compiling po\pt_BR.po >> share/locale/pt_BR/LC_MESSAGES.
Compiling po\pt_PT.po >> share/locale/pt_PT/LC_MESSAGES.
Compiling po\ru.po >> share/locale/ru/LC_MESSAGES.
Compiling po\sk.po >> share/locale/sk/LC_MESSAGES.
Compiling po\sl.po >> share/locale/sl/LC_MESSAGES.
Compiling po\sq.po >> share/locale/sq/LC_MESSAGES.
Compiling po\sv.po >> share/locale/sv/LC_MESSAGES.
Compiling po\uk.po >> share/locale/uk/LC_MESSAGES.
Compiling po\vi.po >> share/locale/vi/LC_MESSAGES.
Compiling po\zh_CN.po >> share/locale/zh_CN/LC_MESSAGES.
running build_py
....
copying gramps\gen\const.py -> build\lib\gramps\gen
running build_scripts
creating build\scripts-2.7
copying and adjusting scripts\gramps -> build\scripts-2.7
C:\Gramps4.0>pause
Hit any key . . .


Possible exception:
setup.py stops because of a missing "intltool-merge".
setup.py assumes for Windows to have either non installed "intltools" or complete installed "intltools". In some rare situations it could be possible to have an incomplete installation of these tools. But because we don't need these tools to run Gramps itself it's necessary to edit setup.py in such cases: Insert "return (0, 0, 0)" direct behind "if sys.platform == 'win32':" in "def intltool_version():".

     ...
def intltool_version():
'''
Return the version of intltool as a tuple.
'''
if sys.platform == 'win32':
return (0, 0, 0)
cmd = ["perl", "-e print qx(intltool-update --version) =~ m/(\d+.\d+.\d+)/;"]
...


• After running this it would be possible to run Gramps from "C:\Gramps4.0" or from some where "C:\Gramps4.0\build\...".
• For easy handling of sources from the repository the author prefers to run it from "C:\Gramps4.0".
• It's also possible to generate .mo files by command line jobs. (TODO WORK: description)
• It's also possible to manipulate const.py manually. (TODO WORK: description)

Work arounds

TODO ISSUE: Each work around to be removed if not necessary any more

• 03.03.2013 (Deprecated): 27.02.2013: Using LANG to force Gramps to use an other language than English runs at least for LANG=de_DE into an error (see 6481)
• 03.03.2013 (Deprecated): Currently there is an issue between setup.py and the code using the content of const.py that's why we need manually changes in ""C:\Gramps4.0\gramps\gen\const.py, line 203 to 206: In all string paths for LOCALE_DIR , DATA_DIR, IMAGE_DIR, DOC_DIR replace '\' by '\\'
• 23.02.2013 (Deprecated): 16.02.2013: see also above how to install the Gtk package. As described in issue 6429 [1] there is a work around to have the drop down menu for gramplets in the side and bottom bar working: new "Gdk-3.0.typelib" from this issue page (TODO ISSUE: to be removed if the new typelib is part of the package)

Overall appearance

A short description 'How to control the general view of Gramps using GTK themes':

• For our example theme packages have to be stored in "C:\Python27\Lib\site-packages\gtk\share\themes". Per default with the here used GTK package there are three packages available:
• Default
• Emacs

To select one of these themes one has to manipulate the a special settings.ini file. For our example it's placed there:

• C:\Python27\Lib\site-packages\gtk\etc\gtk-3.0\settings.ini
• This example for settings.ini defines the theme "Adwaita" and the font "Segoe UI" having the font size 10:
[Settings]
gtk-font-name = Segoe UI 10


Start Gramps

At this point we have a basically running Gramps.

Because we didn't add all packages suggested by the README we didn't have the full functionality. Especially some output formats and the geographic view are not available yet (TODO WORK: Add the missing packages having a usable version.)

Because Gramps 4.0 is still under development there are still several issues and crashes (see bug tracker: http://www.gramps-project.org/bugs/view_all_bug_page.php). It's strongly recommended to use test data for validation only!

To run Gramps a batch seems to be helpful:


set LANG=en_GB

@rem may be some time we need an other language
@rem set LANG=de_DE

@rem it's a good idea to have a own GRAMPSHOME
set GRAMPSHOME=C:\Gramps40
@rem we need the path of the Gtk binaries
set path=C:\Goocanvas;C:\Program Files (x86)\gs\gs9.07\bin;C:\icu;C:\Python27\lib\site-packages\gtk;%path%;C:\Program Files (x86)\Graphviz2.30\bin

C:
cd C:\Python27

@rem call for all version information (e.g. as background for any issue)
python "C:\Gramps4.0\gramps.py" -v

@rem let's start Gramps
python "C:\Gramps4.0\gramps.py"
pause



"Gramps -v" should show this information now (last change 03.03.2013):

Gramps Settings:
----------------
python    : 2.7.3
gramps    : 4.0.0-alpha5-r21574M
gtk++     : 3.6.4
pygobject : 3.4.2
pango     : 1.32.6
Not using bsddb3
bsddb     : 4.8.4.2
bsddb.db  : 4.7.25
cairo     : 1.12.10
pycairo   : 1.10.0
osmgpsmap : 0.8
GExiv2    : 0.4
ICU       : 50.1.2
PyICU     : 1.5
o.s.      : win32

Environment settings:
---------------------
LANG      : de_DE.UTF-8
LANGUAGE  : de_DE
GRAMPSI18N: not set
GRAMPSHOME: C:\Gramps40
GRAMPSDIR : not set
PYTHONPATH:
C:\Python27\python27.zip
C:\Python27\DLLs
C:\Python27\lib
C:\Python27\lib\plat-win
C:\Python27\lib\lib-tk
C:\Python27
C:\Python27\lib\site-packages
C:\Python27\lib\site-packages\PIL

Non-python dependencies:
------------------------
Graphviz  : 2.30
Ghostscr. : 9.07

System PATH env variable:
-------------------------
C:\Goocanvas
C:\Program Files (x86)\gs\gs9.07\bin
C:\icu
C:\Python27\lib\site-packages\gtk
...


Known Major Issues

As known per 01.04. to 18.07.2013

• (23.07.2013 updated: it works well on WinXP 32 bit) The described system doesn't work for WinXP 32bit
• Webview crashes for any web address "http://..." - but runs well for local file access
• 06.04.2013 (resolved with pygi-aio-3.4.2rev11.7z): Graphical and text reports using PDF output crashes with a pango error ("Pango-CRITICAL **: pango_font_description_better_match: assertion `new_match != NULL' failed @ gramplet/welcomegramplet.py")
• no Django
• Spell:
• Opening the note editor having spell activated or activating the spell within the note editor blocks Python / the application for a while (as longer as larger the text).
• The spell settings will not be stored.
• GraphView (third party addon), 13.07.2013: crashes see http://www.gramps-project.org/bugs/view.php?id=6904
• If LANG not equal en_GB Graphic reports in some cases produce empty PDF sheets or force graphviz to crash (see: http://www.gramps-project.org/bugs/view.php?id=6928)