2008-03-11 16:25:18 +05:30
This file contains some useful details on the installation from source code
2015-03-16 06:08:37 +05:30
for Gramps. It does not cover installation of a pre-built binary package.
2008-03-11 16:25:18 +05:30
For that use your package manager, the rest is already done by the packager.
2009-04-22 08:10:18 +05:30
Uninstall old version
2009-03-08 01:41:58 +05:30
---------------------
2015-02-07 00:09:34 +05:30
If you do a source install in the same place as an existing install,
2009-03-14 17:27:35 +05:30
you need to remove the old version first. You can delete the old
2015-02-07 00:09:34 +05:30
version by deleting the installed directories. For example, if your installation prefix is /usr/local, remove the following:
/usr/local/share/gramps
2012-09-30 20:29:36 +05:30
/usr/local/lib/pythonx.x/site-packages/gramps
2015-02-07 00:09:34 +05:30
If you installed with a package manager you might instead need to remove
2012-11-10 15:44:55 +05:30
/usr/local/lib/pythonx.x/dist-packages/gramps
2015-02-07 00:09:34 +05:30
2015-02-28 23:27:00 +05:30
replacing pythonx.x with the python version you used, e.g. python3.4.
2015-02-07 00:09:34 +05:30
Also remove any gramps .egg files that are installed along with the gramps
2015-02-07 20:57:33 +05:30
directory and the file /usr/local/bin/gramps.
2012-09-30 20:29:36 +05:30
2013-03-09 23:18:22 +05:30
If you don't know the list of all files that Gramps installed, you can
reinstall it with the --record option, and take a look at the list this
produces (so python setup.py install --record grampsfiles.txt
2009-03-14 17:27:35 +05:30
2015-03-16 06:08:37 +05:30
Gramps is a python application, so loading happens on reading the
2009-03-14 17:27:35 +05:30
files, meaning that files of a previous version that are no longer
present in the new version can still be loaded, making the new install
2012-09-30 20:29:36 +05:30
unstable!
2008-03-11 16:25:18 +05:30
2012-09-30 20:29:36 +05:30
distutils install
-----------------
2015-02-07 03:27:02 +05:30
We do not check all dependencies of Gramps, see README for a list of
all required and optional dependencies. Missing dependencies will
result in runtime errors.
2012-09-30 20:29:36 +05:30
2015-02-07 03:27:02 +05:30
To build and install, whether from a tarball or git repo:
2017-11-05 18:57:29 +05:30
python3 setup.py build
sudo python3 setup.py install
2015-02-07 03:27:02 +05:30
You can avoid using sudo for the install step by specifying a prefix to which you have write priviledge. The default is /usr/local, which is usually owned by root. You can learn of more options with
2017-11-05 18:57:29 +05:30
python3 setup.py --help
2012-09-30 20:29:36 +05:30
2015-02-07 03:59:11 +05:30
One can use gramps from the command line without installing it by
setting the following environment variables, but that won't provide
things like MIME type and desktop entries.
export PYTHONPATH="/top/grampsdir/gramps:$PYTHONPATH"
export GRAMPS_RESOURCES="/top/grampsdir"
See below for ways to invoke Gramps.
2008-03-11 16:25:18 +05:30
2012-09-30 20:59:37 +05:30
Typical install directories in linux (ubuntu) are:
2015-02-28 23:27:00 +05:30
* /usr/local/lib/python3.4/dist-packages/gramps/ : the gramps python module
2012-09-30 20:59:37 +05:30
* /usr/local/share/mime-info : mime info so gramps opens files automatically
* /usr/local/share/icons/gnome : our icons
* /usr/local/share/doc/gramps : documentation, also example .gramps and .gedcom
* /usr/local/bin : the gramps executable
* /usr/local/share/locale/xx/LC_MESSAGES : xx language code, translation
* /usr/local/share/man/man1/xx/man1 : xx language code, man file
* /usr/local/share/mime
* /usr/local/share/mime-info
2012-09-30 21:05:31 +05:30
Running Gramps
2012-09-30 20:59:37 +05:30
--------------
Gramps is python only, so no compilation is needed, you can even run gramps
2015-02-07 01:05:55 +05:30
from the source directory.
2012-09-30 20:59:37 +05:30
2012-11-10 15:44:55 +05:30
a) You installed Gramps, then you can run it with the command
2015-02-07 01:05:55 +05:30
gramps
2012-11-10 15:44:55 +05:30
b) You installed Gramps, and want to start it from the PYTHONPATH. In this
case use the command:
2012-09-30 21:05:31 +05:30
2017-11-05 18:57:29 +05:30
python3 -c 'from gramps.grampsapp import main; main()'
2012-09-30 21:05:31 +05:30
2015-02-07 01:05:55 +05:30
The executable 'gramps' in /usr/local/bin or /usr/bin from a) does
2012-09-30 21:05:31 +05:30
this for you.
2012-11-10 15:44:55 +05:30
b) You downloaded the Gramps source code to a directory, and want to run it.
2014-02-20 02:32:42 +05:30
You can start Gramps from the source code directory with
2012-11-10 15:44:55 +05:30
2017-11-05 18:57:29 +05:30
python3 Gramps.py
2012-09-30 21:05:31 +05:30
2015-02-07 03:59:11 +05:30
See gramps/gen/const.py how Gramps finds its resource directories in case
2014-02-20 02:32:42 +05:30
you encounter problems.
2008-03-11 16:25:18 +05:30
2009-04-22 08:10:18 +05:30
Custom directory installation
-------------------------------------
2015-03-16 06:08:37 +05:30
If you would like to install Gramps without being root, or in an
2012-09-30 20:29:36 +05:30
alternative location on windows, supply the --root argument to setup.py
2009-04-22 08:10:18 +05:30
For example:
2017-11-05 18:57:29 +05:30
python3 setup.py install --root ~/test
2008-03-11 16:25:18 +05:30
Packager's issues
------------------
2012-09-30 20:29:36 +05:30
There is a MANIFEST.in file to indicate the work needed.
To create a source distribution run:
2008-05-17 05:21:36 +05:30
2017-11-05 18:57:29 +05:30
python3 setup.py sdist
2015-06-16 02:05:32 +05:30
If Gramps is built outside of the source tree in a temporary location (e.g. when
packaging for a distribution), the --resourcepath option can be used to specify
the path to the installed location of the Gramps resources (e.g. /usr/share):
2017-11-05 18:57:29 +05:30
python3 setup.py install --resourcepath=/usr/share
