Difference between revisions of "All In One Gramps Software Bundle for Windows"

From Gramps
Jump to: navigation, search
m
(Installation folder: Provide examples of Gramps installation path.)
 
(30 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{man warn| This is a work in progress... |Any files listed here may be '''not suitable''' for normal every day use! (My lawyer advised me to say that, but many people are using this and have reported no problems at all.)<br/>Any comments and help (e.g. on wiki pages) are welcome. Josip}}
+
{{man warn|Gramps 3.4 and earlier.|Any files listed here may be '''not suitable''' for normal every day use! (My lawyer advised me to say that, but many people are using this and have reported no problems at all.)<br/>Any comments and help (e.g. on wiki pages) are welcome. Josip<br/>{{man menu|For Gramps 4.x and newer see [[GrampsAIO-4]]}}}}
  
The '''Gramps "software bundle" for Windows''' or '''GrampsAIO''' is an all-in-one (a.k.a. "AIO") installation package of Gramps which includes all dependencies for the Windows platform.  (See also [[GRAMPS_and_Windows|GRAMPS and Windows]].)
+
The '''Gramps "software bundle" for Windows''' or '''GrampsAIO''' is an all-in-one (a.k.a. "AIO") installation package of Gramps which includes all dependencies for the Windows platform.  (See also [[Gramps and Windows]].)
  
 
Not only are all dependencies included ("bundled"), so that users do not have to first manually install each one of them, but they are
 
Not only are all dependencies included ("bundled"), so that users do not have to first manually install each one of them, but they are
 
installed in such a fashion that Gramps can easily find them.
 
installed in such a fashion that Gramps can easily find them.
  
(Technical details: The
+
For the technically sophisticated, GrampsAIO is rebuild-able: it contains an install script which can make a new installable program from the installed one.
logic for this bundle is that in Windows the first entry in the search path is the current working directory (the one in which the program is started), so if any Gramps dependency is in that same directory there is thus no need to look for that dependency in a system folder and possibly load an incompatible one -- thus "dependency hell" is avoided. This is also the reason why GrampsAIO must be started from its own folder.  Also, in newer Windows versions there may be security restriction with shell scripts so GrampsAIO does not use one.)
 
  
For the technically sophisticated, GrampsAIO is rebuild-able: it contains an install script which can make a new installable program from the installed one.
 
 
For example somebody might like to repackage Gramps with their code changes, or favorite addons, or even their own family trees, etc.  
 
For example somebody might like to repackage Gramps with their code changes, or favorite addons, or even their own family trees, etc.  
  
==Installation Folder==
+
==Technical details==
 +
The Windows logic for this bundle is that the first entry in the search path is the current working directory... the one in which the program is started. So, if any Gramps dependency is in that same working directory, there is no need to look further for that dependency in a system folder. This eliminates the possibility of loading an incompatible one -- thus "dependency hell" is avoided. This is also the reason why GrampsAIO must be started from its own folder.  Also, in newer Windows versions there may be security restriction with shell scripts so GrampsAIO does not use one.)
 +
 
 +
==Installation folder==
 
This distribution is directory based, which means it loads all dependencies from the directory in which they have been installed.
 
This distribution is directory based, which means it loads all dependencies from the directory in which they have been installed.
  
That folder's location depends on whether the person doing the installation has administrative rights on the Windows machine.  If an administrator installs it the directory may be chosen, with the default suggestion being %ProgramFiles%\GrampsAIO (for example C:\Program Files\GrampsAIO).  If a non-administrator installs it, it will be placed in the user's personal tree, in %APPDATA%\GrampsAIO (for example C:\Documents and Settings\Jones\Application Data\GrampsAIO).
+
That folder's location depends on whether the person doing the installation has administrative rights on the Windows machine.  If an administrator installs it, the directory may be chosen. In that case, the default suggestion being <code>%ProgramFiles%\GrampsAIO</code> (for example <code>C:\Program Files\GrampsAIO</code>).  If a non-administrator installs it, it will be placed in the user's personal workspace, in <code>%APPDATA%\GrampsAIO</code> (for example <code>C:\Documents and Settings\Jones\Application Data\GrampsAIO</code>).
 +
 
 +
As an example, a user with administrator rights using GrampsAOI-{{template:Version windows AIO64}}_win64.exe installer and accepting the standard destination folder during installation, <code>C:\Program&nbsp;Files\GrampsAOI64-{{template:Version windows AIO64}}</code> would be the location for the Gramps executable. While not common, installing the 32-bit version of Gramps on a 64-bit OS, the path would be <code>C:\Program&nbsp;Files&nbsp;(x86)\GrampsAIO32-{{template:Version windows AIO32}}</code>. Finally, if you chose to install Gramps in a non-standard directory, use that folder path instead instead.
 +
 
 +
To use it from the console (cmd.exe prompt), you must first go to the directory where the dependencies were installed (<code>GrampsAIO\bin</code>); for example:
  
So if you want to use it from the console/terminal (dos/cmd.exe prompt) you must first go to the directory where those dependencies were installed (GrampsAIO\bin); for example:
 
 
<code>
 
<code>
  cd C:\GrampsAIO\bin; python -EO ..\share\gramps\gramps.py
+
cd C:\GrampsAIO\bin; python -EO ..\share\gramps\gramps.py
 
</code>
 
</code>
 +
 
(but the installation may have been put somewhere else and so you should probably first search for the GrampsAIO\bin folder to make sure).
 
(but the installation may have been put somewhere else and so you should probably first search for the GrampsAIO\bin folder to make sure).
  
Line 32: Line 37:
  
 
==How GrampsAIO was made==
 
==How GrampsAIO was made==
* put all software Gramps needs in one package:
+
* Place all software Gramps needs in one package:
 
# all core non-python libraries and applications
 
# all core non-python libraries and applications
 
# any optional non-python libraries and applications
 
# any optional non-python libraries and applications
Line 41: Line 46:
 
==Software releases:==
 
==Software releases:==
  
The preferred way to get the GrampsAIO bundle is
+
The preferred way to get the GrampsAIO bundle is to download it from the official Gramps software repository.  See [[Download#MS Windows|Download]] for the current version and link to it.
to download it from the official Gramps software
 
repository.  See [[Download#Community supported|Download]]
 
for the current version and link to it.
 
 
 
Older versions or developmental versions are available
 
directly from the GrampsAIO bundle's author.  See below.
 
 
 
===Gramps AIO (32bit)===
 
 
 
<!-- update last version numbers on[[Template:version_windows_AIO32]]-->
 
 
 
{|align="top" cellspacing="20" width=80%
 
|+'''[http://rapidshare.com/users/K65PY0 Gramps AIO Releases]'''
 
!|GrampsAIO
 
|-
 
|{{Release/Box-header|AIO 3.2.5-1|'''2010-12-04'''}}
 
|-
 
|{{Release/Box-header|AIO 3.2.5-2|'''2010-12-04'''}}
 
|-
 
|{{Release/Box-header|AIO 3.2.5-3|'''2010-12-21'''}}
 
|-
 
|{{Release/Box-header|AIO 3.2.5-4|'''2011-01-01'''}}
 
|-
 
|{{Release/Box-header|AIO 3.2.5-5|'''2011-01-08'''}}
 
|-
 
|{{Release/Box-header|AIO 3.2.6-1|'''2011-05-01'''}}
 
|-
 
|{{Release/Box-header|AIO 3.3.0|'''2011-06-21''' <br>Includes: Gramps 3.3.0, Python (2.7.2), GTK & PyGTK ... plus GhostScript for reports, GraphViz and goocanvas for graphs, GtkSpell and various dictionaries for spell-checking, osmgpsmap for GeographyView, pyexiv2, convert and jhead for ImageMetadata}}
 
|}
 
 
 
===Gramps AIO (64bit)===
 
 
 
<!-- update last version numbers on [[Template:version_windows_AIO64]] -->
 
  
{|align="top" cellspacing="20" width=80%
+
You can follow progress of GrampAIO-4 bundle development at their [[GrampsAIO-4|page]] Older versions or developmental versions are available directly from the GrampsAIO bundle's author. See below.
|+'''[http://rapidshare.com/users/K65PY0 Gramps AIO Releases]'''
 
!|GrampsAIO64
 
|-
 
|{{Release/Box-header|AIO64 3.2.5-1|'''2010-12-29'''}}
 
|-
 
|{{Release/Box-header|AIO64 3.2.5-2|'''2010-12-29'''}}
 
|-
 
|{{Release/Box-header|AIO64 3.2.5-3|'''2010-12-31'''}}
 
|-
 
|{{Release/Box-header|AIO64 3.2.5-4|'''2011-01-06'''}}
 
|-
 
|
 
|-
 
|{{Release/Box-header|AIO64 3.2.6-1|'''2011-06-05'''}}
 
|-
 
|{{Release/Box-header|AIO64 3.3.0_beta-1|'''2011-05-29''' <br>Includes: Gramps 3.3.0, Python (2.7.2), GTK & PyGTK ... plus GhostScript for reports, GraphViz and goocanvas for graphs, GtkSpell and various dictionaries for spell-checking, osmgpsmap for GeographyView, pyexiv2, convert and jhead for ImageMetadata}}
 
|}
 
  
 +
==See also==
 +
*[https://nsis.sourceforge.io/Creating_language_files_and_integrating_with_MUI#Another_solution:_Native_PO_File_support Native PO File support] for NSIS (Nullsoft Scriptable Install System)
 +
*[[GrampsAIO-3]]
 +
*[[GrampsAIO-4]]
 +
*[[GrampsAIO-4 package updating]]
  
 
[[Category:Developers/Packaging]]
 
[[Category:Developers/Packaging]]

Latest revision as of 16:19, 18 January 2022

Gnome-important.png
Gramps 3.4 and earlier.

Any files listed here may be not suitable for normal every day use! (My lawyer advised me to say that, but many people are using this and have reported no problems at all.)
Any comments and help (e.g. on wiki pages) are welcome. Josip
For Gramps 4.x and newer see GrampsAIO-4

The Gramps "software bundle" for Windows or GrampsAIO is an all-in-one (a.k.a. "AIO") installation package of Gramps which includes all dependencies for the Windows platform. (See also Gramps and Windows.)

Not only are all dependencies included ("bundled"), so that users do not have to first manually install each one of them, but they are installed in such a fashion that Gramps can easily find them.

For the technically sophisticated, GrampsAIO is rebuild-able: it contains an install script which can make a new installable program from the installed one.

For example somebody might like to repackage Gramps with their code changes, or favorite addons, or even their own family trees, etc.

Technical details

The Windows logic for this bundle is that the first entry in the search path is the current working directory... the one in which the program is started. So, if any Gramps dependency is in that same working directory, there is no need to look further for that dependency in a system folder. This eliminates the possibility of loading an incompatible one -- thus "dependency hell" is avoided. This is also the reason why GrampsAIO must be started from its own folder. Also, in newer Windows versions there may be security restriction with shell scripts so GrampsAIO does not use one.)

Installation folder

This distribution is directory based, which means it loads all dependencies from the directory in which they have been installed.

That folder's location depends on whether the person doing the installation has administrative rights on the Windows machine. If an administrator installs it, the directory may be chosen. In that case, the default suggestion being %ProgramFiles%\GrampsAIO (for example C:\Program Files\GrampsAIO). If a non-administrator installs it, it will be placed in the user's personal workspace, in %APPDATA%\GrampsAIO (for example C:\Documents and Settings\Jones\Application Data\GrampsAIO).

As an example, a user with administrator rights using GrampsAOI-5.1.5_win64.exe installer and accepting the standard destination folder during installation, C:\Program Files\GrampsAOI64-5.1.5 would be the location for the Gramps executable. While not common, installing the 32-bit version of Gramps on a 64-bit OS, the path would be C:\Program Files (x86)\GrampsAIO32-5.1.5. Finally, if you chose to install Gramps in a non-standard directory, use that folder path instead instead.

To use it from the console (cmd.exe prompt), you must first go to the directory where the dependencies were installed (GrampsAIO\bin); for example:

cd C:\GrampsAIO\bin; python -EO ..\share\gramps\gramps.py

(but the installation may have been put somewhere else and so you should probably first search for the GrampsAIO\bin folder to make sure).

Why GrampsAIO was made

  • easy installation:
    • no searching web for appropriate packages
    • one click install
  • no dependency hell:
    • all libraries work together
    • on upgrade of a library all other libraries are rebuilt with that version

How GrampsAIO was made

  • Place all software Gramps needs in one package:
  1. all core non-python libraries and applications
  2. any optional non-python libraries and applications
  3. python bindings for core libraries
  4. python bindings for optional libraries
  • use NSIS (Nullsoft Script-able Install System)

Software releases:

The preferred way to get the GrampsAIO bundle is to download it from the official Gramps software repository. See Download for the current version and link to it.

You can follow progress of GrampAIO-4 bundle development at their page Older versions or developmental versions are available directly from the GrampsAIO bundle's author. See below.

See also