Changes

==Introduction==This page gives information how to run Gramps 4{{man warn|Work in progress!!|Nobody guarantees anything at all!<br/>Any comments and help (e.0g.x from source on a Windows systemwiki pages) are welcome. After some trials there was the result to focus on 32 bit Python 2<br><br>Last update: 19.701.3 because 2014<br><br>'''Work in progress!!'''}}{{out of several issues related to Gtk and database connection. All steps were done by the author on Windows 7 64bit German.date}}

There This page provides information how to run Gramps 4.0.x to 4.1.x from source on a Microsoft Windows system with a 32 bit Python 2.7.6 (and Python 3.2 or greater).The principles are some parts marked as "TODO ISSUE" because still OK. For a time without an AIO package that was a good way to have a running Gramps for Windows using Phyton 2.7.3. But the now available AIO package has a better usability. To prevent two different versions no further actions where done since the beginning of known issues2014.

There are some parts marked as "TODO WORK" because it's not done yet done ({{man menu|Please note: Gramps 4.2.x and newer only work in progress)with Python 3.2 or greater.}}

{{man warn| This is a There are some parts marked as:* "TODO ISSUE" because of known issues.* "TODO WORK" because it's not done yet done (work in progress... <br/>Nobody guarantees anything at all!<br/>Any comments and help (e.g. on wiki pages) are welcome.}}

27==Windows operating system==* Win Vista: no information available* Win7.02x: no special installations are known (all test done using Win7 Professional SP1 64bit German)* Win8.2013x: After some major changes Gramps no information available* Win10.x: no information available* Win XP since April 8th 2014 is also back for this environment!no longer supported by Microsoft and it is recommended you upgrade (How about upgrading to Linux :) )** If you would still like to use Win XP these additional installations are strongly required (all tests done using WinXP Home 32 bit German)*** SP3 (http://www.microsoft.com/de-de/download/confirmation.aspx?id=25129)*** "Microsoft Visual C++ 2008 Redistributable Package (x86)" (http://www.microsoft.com/de-de/download/details.aspx?id=29)*** "Microsoft Visual C++ 2010 Redistributable Package (x86)" (http://www.microsoft.com/de-de/download/details.aspx?id=5555)

Requirements from the Gramps [https://github.com/gramps-project/gramps/blob/maintenance/gramps41/READMEREADME]:

**We use: Python 2.7.3 6 32 bit from httphttps://www.python.org/getitdownloads/ (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 not use "C:\Program Files (x86)\..." because for every change somewhere in this folder one has to activate the administrator's rights again and again.  ===PyGI AIO Package===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): * 19.01.2014: Download '''pygi-aio-3.10.2-win32_rev15-setup.exe''' or newer as a complete installer from:** http://sourceforge.net/projects/pygobjectwin32/files/*The PyGI AIO Package includes the following libraries for Gramps that should be selected during the installation process (you may choose libraries other for additional usages):** gdk-pixbuf (version 2.30.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)** libgexiv2 (version 0.7.0 in pygi-aio-3.10.2-win32_rev15-setup.exe)** goocanvas (version 2.0.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)** gtk+ (version 3.10.6 in pygi-aio-3.10.2-win32_rev15-setup.exe)** gtkspell (version 3.0.3 in pygi-aio-3.10.2-win32_rev15-setup.exe)** osm-gps-map (version 1.0.1 in pygi-aio-3.10.2-win32_rev15-setup.exe)** pango (version 1.36.1 in pygi-aio-3.10.2-win32_rev15-setup.exe)** webkitgtk (version 1.10.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)* To run Gramps there is no need for pygi-aio's optionally provided developer tools.* Don't use the older GTK 3.8.6 (Select "No" as answer at the additional question dialogue!)* Deprecated versions before 15.12.2013 see history Comments (19.01.2014): * All gtk binaries are included in the pygi-aio installer package and correctly placed.* The pygi-aio package has no need for processors having an SSSE3 instruction set.

====Gtk, pyobject====

* GTK 3.0 8.7+ or greater

* cairo, pango, pangocairo with instrospection introspection bindings (the gi packages)

Checking the state of the pygi-aio package can be done confirmed by:* start starting Python (e. g.: C:\Python27>python)

Python 2.7.3 6 (default, Apr Nov 10 20122013, 2319:3124:2618) [MSC v.1500 32 bit (Intel)] on win 32

>>> from gi.repository import GObjectGtk

(3, 410, 2) ====language-pack-gnome-xx====Requirements from README (*STRONGLY RECOMMENDED*):* 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). * 19.01.2014: No further actions necessary, because this GTK package contains also these components.* Deprecated versions before 11.03.2013 see history ====osmgpsmap====Requirements from README (*STRONGLY RECOMMENDED*):* Used to show maps in the geography view. Without this the GeoView will not be active, see [[Gramps_4.1_Wiki_Manual_-_Categories#Geography_Category]]* The package is named osmgpsmap, osm-gps-map or python-osmgpsmap. Or obtain it from: http://nzjrs.github.com/osm-gps-map/ (Comment: There is no direct download from this web page) ==> osmgpsmap is an optional package even the README requires "strongly recommended". Add this package:* 19.01.2014: osmgpsmap is integrated part of the GTK package.  Comments: * 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. ====GExiv2====Is an optional package.19.01.2014: GExiv2 is integrated part of the GTK package.  Because the EditExifMetadata add-on isn't currently available this package is tested for reading exif data only using the "image metadata" gramplet. ====gtkspell====Requirements from README (optional package):* 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.  19.01.2014: The basics to use a spell are already included in the here used GTK package. {{man warn| At least the content of pygi-aio-3.10.2-win32_rev15-setup.exe used by Gramps forces an crash if libenchant_voikko.dll is available!<br/>It is strongly requested to delete ...\Lib\site-packages\gnome\lib\enchant\libenchant_voikko.dll.}} The only missed things may be special myspell dictionaries (comment: Gramps uses myspell only!). These can be found here:* from http://extensions.openoffice.org/ download the language packages of your choice. Included in the there provided .oxt files one can extract by using a program like 7-Zip the necessary .aff and .dic files.* alternate [http://extensions.libreoffice.org/extension-center?getCategories=Dictionary&getCompatibility=any extensions.libreoffice.org/]* Or you may find these files (.aff and .dic) as part of any GrampsAIO installation in "..\share\enchant\myspell" For our example all files *.aff *.dic have to be stored into "C:\Python27\Lib\site-packages\gnome\share\enchant\myspell".  TODO ISSUE/WORK There are still some issues using spell (as per 019.01.2014):* Open the note editor having spell activated slows down the os extremely as longer as larger the text. This may cost more than 45 seconds for a text having 400 lines and 17000 characters. So it's strongly suggested to don't global activate "Enable spelling checker" in Preferences!* Up to Gramps 4.0.2 there is a spell related issue [https://www.gramps-project.org/bugs/view.php?id=7339 #7339] which has to be prevented by the there provided patch! ====gir-webkit====Information from README:* 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  19.01.2014: Webkit is an integrated part of the GTK package.

===ICU/PyICU=goocanvas====Information from README:This new used package is a "must be".* Required for the Graphview plugin

2719.0201.20132014: It's is part of the current GTK package === Not Provided by GTK-AIO package === ====ICU/PyICU====Requirements from README (*STRONGLY RECOMMENDED*): 19.01.2014: Download http://dl.dropbox.com/u/81888101/Gramps/PYICU_py27_win32.zip(This zip provides ICU/PyICU version 1.5 (for current version information see https://pypi.python.org/pypi/PyICU )

* Copy all files 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. In any final version all binaries can be stored in the folderg. But for our trials we prefer a separate folder to be independent from other packages: "C:\icu". Because of In this decision case we have to add the 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. ''If you don't know, where to put dll (you get an "ImportError: DLL load failed" error), put a *.dll in a "C:\Python27\Lib\site-packages" (without a bin subfolder).''

Python 2.7.3 6 (default, Apr Nov 10 20122013, 2319:3124:2618) [MSC v.1500 32 bit (Intel)] on win 32

1.5  ===language-pack-gnome-xx===Requirements from README (*STRONGLY RECOMMENDED*):* 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). It's to find in an other distribution package because of the limits of the used repository: * 27.02.2013: From http://code.google.com/p/osspack32/downloads/detail?name=pygi-aio-3.4.2rev7-opt.7z&can=2&q= download pygi-aio-3.4.2rev7-opt.7z* 23.02.2013 (Deprecated): <strike>From http://code.google.com/p/osspack32/downloads/detail?name=pygi-aio-3.4.2rev6-opt.7z&can=1&q=pygi-aio download pygi-aio-3.4.2rev6-opt.7z</strike>* Deprecated versions before 23.02.2013 see history

Copy the folder "pygi-aio-3Comment (19.401.2rev?-opt2014): There are other unofficial PyICU versions available some where in the web.7z\gtk\share\locale" into But be careful to use other than the related Gtk folder "..\site-packages\gtk\share\locale"one above. For our example this would Unexpected issues may be: "C:\Python27\Lib\site-packages\gtk\share\locale"caused.

===osmgpsmap=GraphViz==Requirements from README (*STRONGLY RECOMMENDED*):* Used to show maps in the geography view. Without this the GeoView will not be active, see http://gramps-project.org/wiki/index.php?title=Gramps_4.0_Wiki_Manual_-_Main_Window#Geography_Category* The package is named osmgpsmap, osm-gps-map or python-osmgpsmap. Or obtain it from: http://nzjrs.github.com/osm-gps-map/  ==> osmgpsmap is an optional package even the README requires "strongly recommended". TODO WORK: Add this package. But where to get? The link above doesn't help currently to get a complete package for this environment. Comment: There is currently no message during the start-up of Gramps about a missing osmgpsmap. The only thing is the missing Geographic view in Gramps. ===GraphViz===

19.01.2014: Following the information on http://www.graphviz.org we get the current installation graphviz-2.30.msi package from http://www.graphviz.org/Download_windows.php and run it: graphviz-2.36.zip

For the examples we used copy the default installation path complete content to "C:\Program Files (x86)\Graphviz2.3036\" and the installation for 'everyone'.

SET PATH=%PATH%;C:\Program Files (x86)\Graphviz2.30\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{{man warn| Using "Graph View" GraphViz 2.34 or higher forces an error (#{{bug|7109}} Fixed in Gramps 4.022.2013: Will not be used any more, replaced by GExiv2'''<br>240).02At #{{bug|7109}} you will find a patch to solve the issue for older versions of Gramps.2013 (Deprecated): <strikebr>Requirements from README (*STRONGLY RECOMMENDED*):* Enables Gramps to manage Exif metadata embedded in your mediaWithout this patch and a still unsolved issue one should use graphviz-2. * Gramps needs version 030.1.3 or greater.* Obtain it zip from: http://tilloywww.graphviz.netorg/pub/graphviz/devstable/pyexiv2windows/download.html The handling is the same as above}}<br>Comments: 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.).

The package will be used by the * alternate http://portableapps.com/node/38245 '''GVEdit (Graphviz) Portable''Image Metadata' Gramplet.

The package will ====pyexiv2===='''24.02.2013: Will not be used any more, replaced in the near future by gexiv2[[Run_Gramps40_for_Windows_from_source_using_Python_2.7.</strike>3#GExiv2 |GExiv2]]'''

====ghostscript ghostview====

* From http://www.ghostscript.com/download/gsdnld.html download the "Ghostscript GPL Release" for "Ghostscript 9.10 for Windows (32 bit)" and run the downloaded file gs907w32gs910w32.exe. For the example we again use the default installation. ** Python / Gramps needs to know the folder where the binaries are stored (default: "C:\Program Files (x86)\gs\gs9.0710\bin")by defining the environment variable PATH. <code>SET PATH=%PATH%;C:\Program Files (x86)\gs\gs9.10\bin\</code>** 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). ===GExiv2===Will ** 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.<br>Comment: This tool will be an used to display .ps files as optional packageresult of reports.So at least it'''27s like e.g. any a .pdf viewer or .rtf viewer. It would be possible to include it into any Gramps package.02But as normally nobody would include a .2013:GExiv2 is still not availablepdf viewer or .rtf viewer into a Gramps package I won''' ===gtkspell===Requirements from README (optional package):* Enable spell checking in the notest suggest to do that for a .ps viewer. * Gtkspell depends on enchant. * A version of gtkspell with gobject introspection is needed, so minimally version 3.0.0alternate http://portableapps.com/apps/utilities/ghostscript_portable

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====

* The [http://en.wikipedia.org/wiki/Revision_Control_System GNU Revision Control System (RCS) ] can be used to manage multiple revisions of your family trees. * See info at http://www.gramps-project.org/wiki/index.php?title=[[Gramps_4.0_Wiki_Manual_1_Wiki_Manual_-_Manage_Family_Trees#Archiving_a_Family_Tree]]

====PIL====

===further Python packages===TODO WORK* alternate: Add the missing packages having a usable version.Because of time all packages not list above are not tried up today. It will be the job of the next time to go ahead to add all these packages. Requirements from READMEhttp: The following packages are optional   ttf//python-freefont More font support in the reportspillow.github.io/

gir====ttf-webkit GObject introspection data of WebKit is required for thefreefont==== hidden view 'Htmlview', which allows websites to be opened in Gramps. Users can unhide the view Information from README: More font support 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 webkitreports

goocanvas207.03.2013 TODO WORK: Required How to use for the Graphview pluginWindows environment. It's assumed that the fonts should be added to the Graphviz environment, but not yet tested.

===dependency viewer===TODO WORK: description ==Start Gramps 4.0.x==

For all examples it's assumed that the Gramps source (e.g. from the GIT repository httphttps://svngithub.com/gramps-project/gramps or the .codetar.sfgz from from http://sourceforge.net/pprojects/gramps/codefiles/branchesStable/maintenance../gramps40) will be stored into "C:\Gramps4.0".

It's helpful to use a Subversion special 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.

There are good experiences using TortoiseSVN TortoiseGIT from http://tortoisesvncode.netgoogle.com/p/tortoisegit/downloads.html.

[Changed 03.12.2013]To run setup.py we need the translation tools from tool msgfmt.exe having a proper version. The installer for poedit (http://sourceforge.net/projects/gnuwin32poedit/files/gettextpoedit/0.141.45/gettextpoedit-01.145.47-setup.exe/download?use_mirror=switch&download=: Download gettext-) provides msgfmt.exe in version 0.1418.41.exe and run it to install0.

Latest version of poedit available from https://poedit.net/download For all examples assumed we assume poedit to be installed to: "C:\Program Files (x86)\GnuWin32\binPoedit" (The default path of the installer).

<codepre> C: cd C:\Gramps4.0 set path=C:\Python27;C:\Program Files (x86)\GnuWin32Poedit\bin;%path% C:\Program Files (x86)\Graphviz2.30Poedit\GettextTools\bin;%path% C:\Python27\python setup.py build pause </codepre> 

* 2719.0201.20132014: Using LANG To get the license information within the Help-About dialogue one has to force copy the file COPYING from the Gramps to use an other language than English runs at least for LANG=de_DE into an error sources root (see [http://wwwe.gramps-project.org/bugs/view.php?id=6481 6481])* Currently there is an issue between setup.py and the code using the content of constg.py that's why we need manually changes in ""C:\Gramps4.0\) into the to be generated folder <grampsroot>\genbuild\constdata (e.py, line 203 to 206g.: C: In all string paths for LOCALE_DIR , DATA_DIR, IMAGE_DIR, DOC_DIR replace '\' by 'Gramps4.0\build\'* 23.02.2013, 16.02.2013 (Deprecateddata): <strike>see also above how to install the Gtk package. As described in issue 6429 [http://www.gramps-project.org/bugs/view.php?id=6429] 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)</strike>

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

* C:\Python27\Lib\site-packages\gtkgnome\etc\gtk-3.0\settings.ini

gtk-theme-name = AdwaitaHighContrast

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 For Gramps 4.0 is still under 1 development there are may still several be issues and crashes etc (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!

<codepre> set LANG=en_GBde_DE

@rem may be some time we need an other language @rem set LANG=de @rem SET LANGUAGE=dede_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.0710\bin;C:\icu;C:\Python27\lib\site-packages\gtk;%path%;C:\Program Files (x86)\Graphviz2.3036\bin

@rem let's jump to Python binaries 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 </codepre>

"Gramps -v" should show this information nowif one uses the gramps-4.0.2.tar.gz from http://sourceforge.net/projects/gramps/files/Stable/:

python : 2.7.36 gramps : 4.0.0-alpha4-r21468M2 gtk++ : 3.10.6.4 pygobject : 3.410.2 pango : 1.3236.61

bsddb : 45.83.4.20

cairo : 1.12.1016

osmgpsmap : not found1.0 GExiv2 : not found0.4 ICU : 50.1.2 PyICU : 1.5

LANG : en_GBde_DE.UTF-8 LANGUAGE : en_GBde_DE

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

Graphviz : 2.3036 Ghostscr. : 9.0710

C:\Goocanvas C:\Program Files (x86)\gs\gs9.0710\bin