#!/usr/bin/env python # -*- coding: utf-8 -*- # # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2012 Nick Hall # Copyright (C) 2012 Rob G. Healey # Copyright (C) 2012 Benny Malengier # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # ''' Gramps distutils module. ''' #check python version first import sys if sys.version_info < (3, 2): raise SystemExit("Gramps requires Python 3.2 or later.") from distutils import log from distutils.core import setup, Command from distutils.util import convert_path, newer from distutils.command.build import build as _build from distutils.command.install import install as _install import os import glob import codecs import subprocess from stat import ST_MODE import io from gramps.version import VERSION import unittest import argparse # this list MUST be a subset of _LOCALE_NAMES in gen/utils/grampslocale.py # (that is, if you add a new language here, be sure it's in _LOCALE_NAMES too) ALL_LINGUAS = ('ar', 'bg', 'ca', 'cs', 'da', 'de', 'el', 'en_GB', 'eo', 'es', 'fi', 'fr', 'he', 'hr', 'hu', 'is', 'it', 'ja', 'lt', 'nb', 'nl', 'nn', 'pl', 'pt_BR', 'pt_PT', 'ru', 'sk', 'sl', 'sq', 'sr', 'sv', 'tr', 'uk', 'vi', 'zh_CN', 'zh_HK', 'zh_TW') _FILES = ('data/tips.xml', 'gramps/plugins/lib/holidays.xml') server = False if '--server' in sys.argv: sys.argv.remove('--server') server = True # check if the resourcepath option is used and store the path # this is for packagers that build out of the source tree # other options to setup.py are passed through resource_path = '' packaging = False argparser = argparse.ArgumentParser(add_help=False) argparser.add_argument("--resourcepath", dest="resource_path") args, passthrough = argparser.parse_known_args() if args.resource_path: resource_path = args.resource_path packaging = True sys.argv = [sys.argv[0]] + passthrough def intltool_version(): ''' Return the version of intltool as a tuple. ''' if sys.platform == 'win32': cmd = ["perl", "-e print qx(intltool-update --version) =~ m/(\d+.\d+.\d+)/;"] try: ver, ret = subprocess.Popen(cmd ,stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True).communicate() ver = ver.decode("utf-8") if ver > "": version_str = ver else: return (0,0,0) except: return (0,0,0) else: cmd = 'intltool-update --version 2> /dev/null' # pathological case retcode, version_str = subprocess.getstatusoutput(cmd) if retcode != 0: return None cmd = 'intltool-update --version 2> /dev/null | head -1 | cut -d" " -f3' retcode, version_str = subprocess.getstatusoutput(cmd) if retcode != 0: # unlikely but just barely imaginable, so leave it return None return tuple([int(num) for num in version_str.split('.')]) def substitute_variables(filename_in, filename_out, subst_vars): ''' Substitute variables in a file. ''' f_in = codecs.open(filename_in, encoding='utf-8') f_out = codecs.open(filename_out, encoding='utf-8', mode='w') for line in f_in: for variable, substitution in subst_vars: line = line.replace(variable, substitution) f_out.write(line) f_in.close() f_out.close() def build_trans(build_cmd): ''' Translate the language files into gramps.mo ''' data_files = build_cmd.distribution.data_files for lang in ALL_LINGUAS: po_file = os.path.join('po', lang + '.po') mo_file = os.path.join(build_cmd.build_base, 'mo', lang, 'LC_MESSAGES', 'gramps.mo') mo_file_unix = (build_cmd.build_base + '/mo/' + lang + '/LC_MESSAGES/gramps.mo') mo_dir = os.path.dirname(mo_file) if not(os.path.isdir(mo_dir) or os.path.islink(mo_dir)): os.makedirs(mo_dir) if newer(po_file, mo_file): cmd = 'msgfmt %s -o %s' % (po_file, mo_file) if os.system(cmd) != 0: os.remove(mo_file) msg = 'ERROR: Building language translation files failed.' ask = msg + '\n Continue building y/n [n] ' reply = input(ask) if reply in ['n', 'N']: raise SystemExit(msg) log.info('Compiling %s >> %s', po_file, mo_file) #linux specific piece: target = 'share/locale/' + lang + '/LC_MESSAGES' data_files.append((target, [mo_file_unix])) def build_man(build_cmd): ''' Compresses Gramps manual files ''' data_files = build_cmd.distribution.data_files for man_dir, dirs, files in os.walk(os.path.join('data', 'man')): if 'gramps.1.in' in files: filename = os.path.join(man_dir, 'gramps.1.in') newdir = os.path.join(build_cmd.build_base, man_dir) if not(os.path.isdir(newdir) or os.path.islink(newdir)): os.makedirs(newdir) newfile = os.path.join(newdir, 'gramps.1') subst_vars = (('@VERSION@', VERSION), ) substitute_variables(filename, newfile, subst_vars) import gzip man_file_gz = os.path.join(newdir, 'gramps.1.gz') if os.path.exists(man_file_gz): if newer(filename, man_file_gz): os.remove(man_file_gz) else: filename = False os.remove(newfile) if filename: #Binary io, so open is OK with open(newfile, 'rb') as f_in,\ gzip.open(man_file_gz, 'wb') as f_out: f_out.writelines(f_in) log.info('Compiling %s >> %s', filename, man_file_gz) os.remove(newfile) filename = False lang = man_dir[8:] src = build_cmd.build_base + '/data/man/' + lang + '/gramps.1.gz' target = 'share/man/' + lang + '/man1' data_files.append((target, [src])) def build_intl(build_cmd): ''' Merge translation files into desktop and mime files ''' for filename in _FILES: filename = convert_path(filename) strip_files(filename + '.in', filename, ['_tip', '_name']) i_v = intltool_version() if i_v is None or i_v < (0, 25, 0): log.info('No intltool or version < 0.25.0, build_intl is aborting') return data_files = build_cmd.distribution.data_files base = build_cmd.build_base merge_files = (('data/gramps.desktop', 'share/applications', '-d'), ('data/gramps.keys', 'share/mime-info', '-k'), ('data/gramps.xml', 'share/mime/packages', '-x'), ('data/gramps.appdata.xml', 'share/metainfo', '-x')) for filename, target, option in merge_files: filenamelocal = convert_path(filename) newfile = os.path.join(base, filenamelocal) newdir = os.path.dirname(newfile) if not(os.path.isdir(newdir) or os.path.islink(newdir)): os.makedirs(newdir) merge(filenamelocal + '.in', newfile, option) data_files.append((target, [base + '/' + filename])) def strip_files(in_file, out_file, mark): ''' strip the file of the first character (typically an underscore) in each keyword (in the "mark" argument list) in the file -- so this method is an Alternative to intltool-merge command. ''' if (not os.path.exists(out_file) and os.path.exists(in_file)): old = open(in_file, 'r', encoding='utf-8') with open(out_file, 'w', encoding='utf-8', errors='strict') as fb: for line in old: for marker in mark: line = line.replace(marker, marker[1:]) fb.write(line) old.close() log.info('Compiling %s >> %s', in_file, out_file) def merge(in_file, out_file, option, po_dir='po', cache=True): ''' Run the intltool-merge command. ''' option += ' -u' if cache: cache_file = os.path.join('po', '.intltool-merge-cache') option += ' -c ' + cache_file if (not os.path.exists(out_file) and os.path.exists(in_file)): if sys.platform == 'win32': cmd = (('set LC_ALL=C && perl -S intltool-merge %(opt)s %(po_dir)s %(in_file)s ' '%(out_file)s') % {'opt' : option, 'po_dir' : po_dir, 'in_file' : in_file, 'out_file' : out_file}) else: cmd = (('LC_ALL=C intltool-merge %(opt)s %(po_dir)s %(in_file)s ' '%(out_file)s') % {'opt' : option, 'po_dir' : po_dir, 'in_file' : in_file, 'out_file' : out_file}) if os.system(cmd) != 0: msg = ('ERROR: %s was not merged into the translation files!\n' % out_file) raise SystemExit(msg) log.info('Compiling %s >> %s', in_file, out_file) class build(_build): """Custom build command.""" def run(self): build_trans(self) if not sys.platform == 'win32': build_man(self) build_intl(self) _build.run(self) class install(_install): """Custom install command.""" def run(self): resource_file = os.path.join(os.path.dirname(__file__), 'gramps', 'gen', 'utils', 'resource-path') with io.open(resource_file, 'w', encoding='utf-8', errors='strict') as fp: if packaging: path = resource_path else: path = os.path.abspath(os.path.join(self.install_data, 'share')) fp.write(path) _install.run(self) os.remove(resource_file) class test(Command): """Command to run Gramps unit tests""" description = "run all unit tests" user_options = [] def initialize_options(self): pass def finalize_options(self): pass def run(self): if not os.path.exists('build'): raise RuntimeError("No build directory. Run `python setup.py build` before trying to run tests.") os.environ['GRAMPS_RESOURCES'] = '.' all_tests = unittest.TestLoader().discover('.', pattern='*_test.py') unittest.TextTestRunner(verbosity=self.verbose).run(all_tests) #------------------------------------------------------------------------- # # Packages # #------------------------------------------------------------------------- package_core = ['gramps', 'gramps.cli', 'gramps.cli.plug', 'gramps.gen.utils.docgen', 'gramps.gen', 'gramps.gen.datehandler', 'gramps.gen.db', 'gramps.gen.display', 'gramps.gen.filters', 'gramps.gen.filters.rules', 'gramps.gen.filters.rules.citation', 'gramps.gen.filters.rules.event', 'gramps.gen.filters.rules.family', 'gramps.gen.filters.rules.media', 'gramps.gen.filters.rules.note', 'gramps.gen.filters.rules.person', 'gramps.gen.filters.rules.place', 'gramps.gen.filters.rules.repository', 'gramps.gen.filters.rules.source', 'gramps.gen.lib', 'gramps.gen.merge', 'gramps.gen.mime', 'gramps.gen.plug', 'gramps.gen.plug.docbackend', 'gramps.gen.plug.docgen', 'gramps.gen.plug.menu', 'gramps.gen.plug.report', 'gramps.gen.proxy', 'gramps.gen.simple', 'gramps.gen.utils', 'gramps.gen.utils.docgen', 'gramps.test', 'gramps.plugins', 'gramps.plugins.docgen', 'gramps.plugins.drawreport', 'gramps.plugins.export', 'gramps.plugins.gramplet', 'gramps.plugins.graph', 'gramps.plugins.importer', 'gramps.plugins.lib', 'gramps.plugins.lib.maps', 'gramps.plugins.mapservices', 'gramps.plugins.quickview', 'gramps.plugins.rel', 'gramps.plugins.sidebar', 'gramps.plugins.textreport', 'gramps.plugins.tool', 'gramps.plugins.view', 'gramps.plugins.webreport', 'gramps.plugins.webstuff', ] package_gui = ['gramps.gui', 'gramps.gui.editors', 'gramps.gui.editors.displaytabs', 'gramps.gui.filters', 'gramps.gui.filters.sidebar', 'gramps.gui.logger', 'gramps.gui.merge', 'gramps.gui.plug', 'gramps.gui.plug.export', 'gramps.gui.plug.quick', 'gramps.gui.plug.report', 'gramps.gui.selectors', 'gramps.gui.views', 'gramps.gui.views.treemodels', 'gramps.gui.widgets', ] package_webapp = ['gramps.webapp', 'gramps.webapp.grampsdb', 'gramps.webapp.grampsdb.templatetags', 'gramps.webapp.grampsdb.view', ] if server: packages = package_core + package_webapp else: packages = package_core + package_gui #------------------------------------------------------------------------- # # Package data # #------------------------------------------------------------------------- # add all subdirs of plugin with glade: package_data_core = [] basedir = os.path.join('gramps', 'plugins') for (dirpath, dirnames, filenames) in os.walk(basedir): root, subdir = os.path.split(dirpath) if subdir.startswith("."): dirnames[:] = [] continue for dirname in dirnames: # Skip hidden and system directories: if dirname.startswith("."): dirnames.remove(dirname) #we add to data_list so glade , xml, files are found, we don't need the gramps/ part package_data_core.append(dirpath[7:] + '/' + dirname + '/*.glade') package_data_core.append(dirpath[7:] + '/' + dirname + '/*.xml') package_data_core.append('gen/utils/resource-path') package_data_gui = ['gui/glade/*.glade'] package_data_webapp = ['webapp/*.sql', 'webapp/grampsdb/sql/*.sql'] if server: package_data = package_data_core + package_data_webapp else: package_data = package_data_core + package_data_gui #------------------------------------------------------------------------- # # Resources # #------------------------------------------------------------------------- data_files_core = [('share/mime-info', ['data/gramps.mime']), ('share/icons', ['images/gramps.png'])] DOC_FILES = ['AUTHORS', 'COPYING', 'FAQ', 'INSTALL', 'LICENSE', 'NEWS', 'README', 'TODO'] GEDCOM_FILES = glob.glob(os.path.join('example', 'gedcom', '*.*')) GRAMPS_FILES = glob.glob(os.path.join('example', 'gramps', '*.*')) IMAGE_WEB = glob.glob(os.path.join('images', 'webstuff', '*.png')) IMAGE_WEB.extend(glob.glob(os.path.join('images', 'webstuff','*.ico'))) IMAGE_WEB.extend(glob.glob(os.path.join('images', 'webstuff', '*.gif'))) JS_FILES = glob.glob(os.path.join('data', 'javascript', '*.js')) CSS_FILES = glob.glob(os.path.join('data', 'css', '*.css')) SWANKY_PURSE = glob.glob(os.path.join('data', 'css', 'swanky-purse', '*.css')) SWANKY_IMG = glob.glob(os.path.join('data', 'css', 'swanky-purse', 'images', '*.png')) data_files_core.append(('share/doc/gramps', DOC_FILES)) data_files_core.append(('share/doc/gramps/example/gedcom', GEDCOM_FILES)) data_files_core.append(('share/doc/gramps/example/gramps', GRAMPS_FILES)) data_files_core.append(('share/gramps/images/webstuff', IMAGE_WEB)) data_files_core.append(('share/gramps/css', CSS_FILES)) data_files_core.append(('share/gramps/css/swanky-purse', SWANKY_PURSE)) data_files_core.append(('share/gramps/css/swanky-purse/images', SWANKY_IMG)) PNG_FILES = glob.glob(os.path.join('data', '*.png')) SVG_FILES = glob.glob(os.path.join('data', '*.svg')) data_files_core.append(('share/icons/gnome/48x48/mimetypes', PNG_FILES)) data_files_core.append(('share/icons/gnome/scalable/mimetypes', SVG_FILES)) XML_FILES = glob.glob(os.path.join('data', '*.xml')) data_files_core.append(('share/gramps', XML_FILES)) data_files_gui = [] IMAGE_FILES = glob.glob(os.path.join('images', '*.*')) THEME = os.path.join('images', 'hicolor') ICON_16 = glob.glob(os.path.join(THEME, '16x16', 'actions', '*.png')) ICON_22 = glob.glob(os.path.join(THEME, '22x22', 'actions', '*.png')) ICON_24 = glob.glob(os.path.join(THEME, '24x24', 'actions', '*.png')) ICON_48 = glob.glob(os.path.join(THEME, '48x48', 'actions', '*.png')) ICON_SC = glob.glob(os.path.join(THEME, 'scalable', 'actions', '*.svg')) data_files_gui.append(('share/gramps/images', IMAGE_FILES)) data_files_gui.append(('share/gramps/images/hicolor/16x16/actions', ICON_16)) data_files_gui.append(('share/gramps/images/hicolor/22x22/actions', ICON_22)) data_files_gui.append(('share/gramps/images/hicolor/24x24/actions', ICON_24)) data_files_gui.append(('share/gramps/images/hicolor/48x48/actions', ICON_48)) data_files_gui.append(('share/gramps/images/hicolor/scalable/actions', ICON_SC)) data_files_webapp = [] TEMPLATE_FILES = glob.glob(os.path.join('data/templates', '*.html')) data_files_webapp.append(('share/gramps/templates', TEMPLATE_FILES)) ADMIN_FILES = glob.glob(os.path.join('data/templates/admin', '*.html')) data_files_webapp.append(('share/gramps/templates/admin', ADMIN_FILES)) REG_FILES = glob.glob(os.path.join('data/templates/registration', '*.html')) data_files_webapp.append(('share/gramps/templates/registration', REG_FILES)) if server: data_files = data_files_core + data_files_webapp else: data_files = data_files_core + data_files_gui #------------------------------------------------------------------------- # # Setup # #------------------------------------------------------------------------- setup(name = 'gramps', description = ('Gramps (Genealogical Research and Analysis Management ' 'Programming System)'), long_description = ('Gramps (Genealogical Research and Analysis ' 'Management Programming System) is a full featured ' 'genealogy program supporting a Python based plugin ' 'system.'), version = VERSION, author = 'Donald N. Allingham', author_email = 'don@gramps-project.org', maintainer = 'Gramps Development Team', maintainer_email = 'benny.malengier@gmail.com', url = 'http://gramps-project.org', license = 'GPL v2 or greater', platforms = ['FreeBSD', 'Linux', 'MacOS', 'Windows'], cmdclass = {'build': build, 'install': install, 'test': test}, packages = packages, package_data = {'gramps': package_data}, data_files = data_files, scripts = ['scripts/gramps'], classifiers = [ "Classifier: Development Status :: 5 - Production/Stable", "Classifier: Environment :: Console", "Classifier: Environment :: MacOS X", "Classifier: Environment :: Plugins", "Classifier: Environment :: Web Environment", "Classifier: Environment :: Win32 (MS Windows)", "Classifier: Environment :: X11 Applications :: GTK", "Classifier: Framework :: Django", "Classifier: Intended Audience :: Education", "Classifier: Intended Audience :: End Users/Desktop", "Classifier: Intended Audience :: Other Audience", "Classifier: Intended Audience :: Science/Research", "Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Classifier: Natural Language :: Arabic", "Classifier: Natural Language :: Bulgarian", "Classifier: Natural Language :: Catalan", "Classifier: Natural Language :: Chinese (Simplified)", "Classifier: Natural Language :: Croatian", "Classifier: Natural Language :: Czech", "Classifier: Natural Language :: Danish", "Classifier: Natural Language :: Dutch", "Classifier: Natural Language :: English", "Classifier: Natural Language :: Esperanto", "Classifier: Natural Language :: Finnish", "Classifier: Natural Language :: French", "Classifier: Natural Language :: German", "Classifier: Natural Language :: Greek", "Classifier: Natural Language :: Hebrew", "Classifier: Natural Language :: Hungarian", "Classifier: Natural Language :: Italian", "Classifier: Natural Language :: Japanese", "Classifier: Natural Language :: Macedonian", "Classifier: Natural Language :: Norwegian", "Classifier: Natural Language :: Polish", "Classifier: Natural Language :: Portuguese", "Classifier: Natural Language :: Portuguese (Brazilian)", "Classifier: Natural Language :: Romanian", "Classifier: Natural Language :: Russian", "Classifier: Natural Language :: Serbian", "Classifier: Natural Language :: Slovak", "Classifier: Natural Language :: Slovenian", "Classifier: Natural Language :: Spanish", "Classifier: Natural Language :: Swedish", "Classifier: Natural Language :: Turkish", "Classifier: Natural Language :: Vietnamese", "Classifier: Operating System :: MacOS", "Classifier: Operating System :: Microsoft :: Windows", "Classifier: Operating System :: Other OS", "Classifier: Operating System :: POSIX :: BSD", "Classifier: Operating System :: POSIX :: Linux", "Classifier: Operating System :: POSIX :: SunOS/Solaris", "Classifier: Operating System :: Unix", "Classifier: Programming Language :: Python", "Classifier: Programming Language :: Python :: 3", "Classifier: Topic :: Database", "Classifier: Topic :: Desktop Environment :: Gnome", "Classifier: Topic :: Education", "Classifier: Topic :: Scientific/Engineering :: Visualization", "Classifier: Topic :: Sociology :: Genealogy", ] )