Mercurial > libervia-backend

annotate setup.py @ 1100:2be46f391cfa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
setup: SAT_INSTALL environment variable handles "clean" and "purge" options
author souliane <souliane@mailoo.org>
date Tue, 15 Jul 2014 13:37:50 +0200
parents a32ef03d4af0
children 8e15eeb3cfc3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
1 #!/usr/bin/env python2
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
4 # SAT: a jabber client
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
6 # Copyright (C) 2013, 2014 Adrien Cossa (souliane@mailoo.org)
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 237
diff changeset
7
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
8 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
9 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
10 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
11 # (at your option) any later version.
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 237
diff changeset
12
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
13 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
16 # GNU Affero General Public License for more details.
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 237
diff changeset
17
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
18 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 607
diff changeset
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 237
diff changeset
20
230
b25cbec73c1e distutils: removes build and dist from manifest's prune
Goffi <goffi@goffi.org>
parents: 227
diff changeset
21 from distribute_setup import use_setuptools
b25cbec73c1e distutils: removes build and dist from manifest's prune
Goffi <goffi@goffi.org>
parents: 227
diff changeset
22 use_setuptools()
b25cbec73c1e distutils: removes build and dist from manifest's prune
Goffi <goffi@goffi.org>
parents: 227
diff changeset
23 from setuptools.command.install import install
b25cbec73c1e distutils: removes build and dist from manifest's prune
Goffi <goffi@goffi.org>
parents: 227
diff changeset
24 from setuptools import setup
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from distutils.file_util import copy_file
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
26 import os
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
27 import sys
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
28 import subprocess
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29 from stat import ST_MODE
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
30 import shutil
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
31
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33 NAME = 'sat'
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34 LAUNCH_DAEMON_COMMAND = 'sat'
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
36 ENV_SAT_INSTALL = "SAT_INSTALL" # environment variable to customise installation
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
37 NO_PREINSTALL_OPT = 'nopreinstall' # skip all preinstallation checks
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
38 AUTO_DEB_OPT = 'autodeb' # automaticaly install debs
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
39 NO_X_OPT = 'nox' # don't install X dependant packages
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
40 CLEAN_OPT = 'clean' # remove previous installation directories
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
41 PURGE_OPT = 'purge' # remove building and previous installation directories
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
42
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
43
232
0cd5b3c4513f Distutils: added custom wokkel checking/building
Goffi <goffi@goffi.org>
parents: 230
diff changeset
44 class MercurialException(Exception):
0cd5b3c4513f Distutils: added custom wokkel checking/building
Goffi <goffi@goffi.org>
parents: 230
diff changeset
45 pass
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
46
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
47
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
48 def module_installed(module_name):
547
8b5e142354ca installation: added wokkel to dependencies, and removed custom wokkel installation in setup.py (muc branch is now merged mainstream)
Goffi <goffi@goffi.org>
parents: 480
diff changeset
49 """Try to import module_name, and return False if it failed
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
50 @param module_name: name of the module to test
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
51 @return: True if successful"""
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
52 try:
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
53 __import__(module_name)
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
54 except ImportError:
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
55 return False
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
56 return True
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
57
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
58
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
59 class CustomInstall(install):
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
60
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
61 def custom_auto_options(self):
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
62 """Change options for twistd in the shell script
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
63 Mainly change the paths"""
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
64 sh_buffer = ""
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
65 run_dir = os.path.dirname(self.sh_script_path)
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
66 with open(self.sh_script_path, 'r') as sh_file:
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
67 for ori_line in sh_file:
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
68 if ori_line.startswith('DAEMON='):
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
69 dest_line = 'DAEMON=""\n' # we want to launch sat as a daemon
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
70 elif ori_line.startswith('TAP_PATH='):
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
71 dest_line = 'TAP_PATH="%s/"\n' % run_dir
473
a11cde0cdf5b misc: Make the shell launcher use the same python interpreter than setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 472
diff changeset
72 elif ori_line.startswith('PYTHON='):
a11cde0cdf5b misc: Make the shell launcher use the same python interpreter than setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 472
diff changeset
73 dest_line = 'PYTHON="%s"\n' % sys.executable
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
74 else:
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
75 dest_line = ori_line
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
76 sh_buffer += dest_line
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
77
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
78 with open(self.sh_script_path, 'w') as sh_file:
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
79 sh_file.write(sh_buffer)
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
80
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
81 def custom_create_links(self):
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
82 """Create symbolic links to executables"""
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
83 # the script which launch the daemon
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
84 for source, dest in self.sh_script_links:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
85 if os.path.islink(dest) and os.readlink(dest) != source:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
86 os.remove(dest) # copy_file doesn't force the link update
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
87 dest_name, copied = copy_file(source, dest, link='sym')
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
88 assert (copied)
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
89 # we change the perm in the same way as in the original install_scripts
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
90 mode = ((os.stat(dest_name)[ST_MODE]) | 0555) & 07777
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
91 os.chmod(dest_name, mode)
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
92
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
93 def run(self):
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
94 self.sh_script_path = os.path.join(self.install_lib, NAME, 'sat.sh')
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
95 self.sh_script_links = [(self.sh_script_path, os.path.join(self.install_scripts, LAUNCH_DAEMON_COMMAND))]
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
96 sys.stdout.write('running pre installation stuff\n')
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
97 sys.stdout.flush()
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
98 if PURGE_OPT in install_opt:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
99 self.purge()
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
100 elif CLEAN_OPT in install_opt:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
101 self.clean()
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
102 install.run(self)
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
103 sys.stdout.write('running post installation stuff\n')
349
3ec237e82aed setup.py update:
Goffi <goffi@goffi.org>
parents: 335
diff changeset
104 sys.stdout.flush()
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
105 self.custom_auto_options()
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
106 self.custom_create_links()
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
107
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
108 def confirm(self, message):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
109 """Ask the user for a confirmation"""
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
110 message += 'Proceed'
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
111 while True:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
112 res = raw_input("%s (y/n)? " % message)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
113 if res not in ['y', 'Y', 'n', 'N']:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
114 print "Your response ('%s') was not one of the expected responses: y, n" % res
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
115 message = 'Proceed'
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
116 continue
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
117 if res in ('y', 'Y'):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
118 return True
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
119 return False
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
120
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
121 def clean(self, message=None, to_remove=None):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
122 """Clean previous installation directories
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
123
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
124 @param message (str): to use a non-default confirmation message
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
125 @param to_remove (str): extra files/directories to remove
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
126 """
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
127 if message is None:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
128 message = "Cleaning previous installation directories"
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
129 if to_remove is None:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
130 to_remove = []
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
131 to_remove.extend([os.path.join(self.install_lib, NAME),
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
132 os.path.join(self.install_data, 'share', 'doc', NAME),
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
133 os.path.join(self.install_lib, "%s-py%s.egg-info" % (self.config_vars['dist_fullname'], self.config_vars['py_version_short'])),
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
134 ])
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
135 for source, dest in self.sh_script_links:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
136 if os.path.islink(dest):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
137 to_remove.append(dest)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
138
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
139 for script in ('jp', 'wix', 'primitivus'):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
140 dest = os.path.join(self.install_scripts, script)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
141 if os.path.exists(dest):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
142 to_remove.append(dest)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
143
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
144 message = "%s:\n%s\n" % (message, "\n".join([" %s" % path for path in to_remove]))
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
145 if not self.confirm(message):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
146 return
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
147 sys.stdout.write('cleaning previous installation directories...\n')
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
148 sys.stdout.flush()
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
149 for path in to_remove:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
150 if os.path.isdir(path):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
151 shutil.rmtree(path, ignore_errors=True)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
152 else:
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
153 os.remove(path)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
154
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
155 def purge(self):
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
156 """Clean building and previous installation directories"""
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
157 message = "Cleaning building and previous installation directories"
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
158 to_remove = [os.path.join(os.getcwd(), 'build')]
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
159 self.clean(message, to_remove)
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
160
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
161
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
162 def preinstall_check(install_opt):
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
163 """Check presence of problematic dependencies, and try to install them with package manager
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
164 This ugly stuff is necessary as distributions are not installed correctly with setuptools/distribute
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
165 Hope to remove this at some point"""
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
166
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
167 #modules_tocheck = ['twisted', 'twisted.words', 'twisted.web', 'wx', 'urwid']
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
168 modules_tocheck = ['gobject'] # XXX: python-gobject is not up-to-date in PyPi
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
169 if NO_X_OPT not in install_opt:
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
170 modules_tocheck.append('wx') # wx is the only one to be really difficult to install
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
171
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
172 package = {'twisted': 'python-twisted-core',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
173 'twisted.words': 'python-twisted-words',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
174 'twisted.web': 'python-twisted-web',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
175 'wx': 'python-wxgtk2.8',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
176 'urwid': 'python-urwid',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
177 'gobject': 'python-gobject',
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
178 'mercurial': 'mercurial'} # this dict map dependencies to packages names for debian distributions
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
179
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
180 sys.stdout.write("Running pre-installation dependencies check\n")
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
181
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
182 # which modules are not installed ?
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
183 modules_toinstall = [mod for mod in modules_tocheck if not module_installed(mod)]
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
184 """# is mercurial available ?
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
185 hg_installed = subprocess.call('which hg', stdout=open('/dev/null', 'w'), shell=True) == 0
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
186 if not hg_installed:
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
187 modules_toinstall.append('mercurial')""" # hg can be installed from pypi
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
188
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
189 if modules_toinstall:
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
190 if AUTO_DEB_OPT in install_opt: # auto debian installation is requested
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
191 # are we on a distribution using apt ?
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
192 apt_path = subprocess.Popen('which apt-get', stdout=subprocess.PIPE, shell=True).communicate()[0][:-1]
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
193 else:
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
194 apt_path = None
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
195
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
196 not_installed = set()
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
197 if apt_path:
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
198 # we have apt, we'll try to use it
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
199 for module_name in modules_toinstall:
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
200 package_name = package[module_name]
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
201 sys.stdout.write("Installing %s\n" % package_name)
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
202 success = subprocess.call('%s -qy install %s' % (apt_path, package_name), shell=True) == 0
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
203 if not success:
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
204 not_installed.add(module_name)
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
205 else:
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
206 not_installed = set(modules_toinstall)
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
207
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
208 if not_installed:
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
209 # some packages can't be automatically installed, we print their name for manual installation
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
210 sys.stdout.write("You should install the following dependencies with your distribution recommanded tool before installing %s:\n" % NAME)
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
211 for module_name in not_installed:
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
212 sys.stdout.write("- %s (Debian name: %s)\n" % (module_name, package[module_name]))
235
7a2ef5fe4e8d distutils: added preinstall_check hack + some tuning while testing
Goffi <goffi@goffi.org>
parents: 233
diff changeset
213 sys.exit(2)
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
214
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 1054
diff changeset
215
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
216 if sys.argv[1].lower() in ['egg_info', 'install']:
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
217 # we only check dependencies if egg_info or install is used
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
218 install_opt = os.environ.get(ENV_SAT_INSTALL, "").split()
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
219 if not NO_PREINSTALL_OPT in install_opt: # user can force preinstall skipping
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
220 preinstall_check(install_opt)
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
221
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
222 setup(name=NAME,
887
f93e917be3f4 version update
Goffi <goffi@goffi.org>
parents: 884
diff changeset
223 version='0.4.1',
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
224 description=u'Salut à Toi multi-frontend XMPP client',
580
07d7c496ece9 misc: setup.py long description update
Goffi <goffi@goffi.org>
parents: 575
diff changeset
225 long_description=u'Salut à Toi (SàT) is a XMPP client based on a daemon/frontend architecture. Its multi-frontends (desktop, web, console interface, CLI, etc) and multi-purposes (instant messaging, microblogging, games, file sharing, etc).',
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
226 author='Goffi (Jérôme Poisson)',
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
227 author_email='goffi@goffi.org',
884
4054cf716322 setup.py fixes and improvments
Goffi <goffi@goffi.org>
parents: 881
diff changeset
228 url='http://www.salut-a-toi.org',
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
229 classifiers=['Development Status :: 3 - Alpha',
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
230 'Environment :: Console',
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
231 'Environment :: X11 Applications :: GTK',
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
232 'Framework :: Twisted',
480
2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents: 473
diff changeset
233 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
225
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
234 'Operating System :: POSIX :: Linux',
fd9b7834d98a distutils installation script, draft
Goffi <goffi@goffi.org>
parents:
diff changeset
235 'Topic :: Communications :: Chat'],
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
236 package_dir={'sat': 'src', 'sat_frontends': 'frontends/src'},
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
237 packages=['sat', 'sat.tools', 'sat.bridge', 'sat.plugins', 'sat.test', 'sat.core', 'sat.memory',
848
d40306d1da70 misc: setup.py was not installing sat_frontends.jp
souliane <souliane@mailoo.org>
parents: 774
diff changeset
238 'sat_frontends', 'sat_frontends.bridge', 'sat_frontends.quick_frontend', 'sat_frontends.jp',
987
3a96920c07b7 core, frontends: unify the roster management UIs in sat/stdui/ui_contact_list.py
souliane <souliane@mailoo.org>
parents: 932
diff changeset
239 'sat_frontends.primitivus', 'sat_frontends.wix', 'sat_frontends.tools', 'sat.stdui'],
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
240 package_data={'sat': ['sat.tac', 'sat.sh'],
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
241 'sat_frontends': ['wix/COPYING']},
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
242 data_files=[(os.path.join(sys.prefix, 'share/locale/fr/LC_MESSAGES'), ['i18n/fr/LC_MESSAGES/sat.mo']),
227
533507bb4e32 distutils wix installation
Goffi <goffi@goffi.org>
parents: 225
diff changeset
243 ('share/doc/%s' % NAME, ['CHANGELOG', 'COPYING', 'INSTALL', 'README', 'README4TRANSLATORS']),
533507bb4e32 distutils wix installation
Goffi <goffi@goffi.org>
parents: 225
diff changeset
244 ],
533507bb4e32 distutils wix installation
Goffi <goffi@goffi.org>
parents: 225
diff changeset
245 scripts=['frontends/src/jp/jp', 'frontends/src/primitivus/primitivus', 'frontends/src/wix/wix'],
230
b25cbec73c1e distutils: removes build and dist from manifest's prune
Goffi <goffi@goffi.org>
parents: 227
diff changeset
246 zip_safe=False,
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
247 dependency_links=['http://www.blarg.net/%7Esteveha/pyfeed-0.7.4.tar.gz', 'http://www.blarg.net/%7Esteveha/xe-0.7.4.tar.gz'],
1054
a32ef03d4af0 installation: added python OTR dependency
Goffi <goffi@goffi.org>
parents: 1038
diff changeset
248 install_requires=['twisted', 'wokkel >= 0.7.1', 'progressbar', 'urwid >= 1.1.0', 'urwid-satext >= 0.3.0', 'pyfeed', 'xe', 'mutagen', 'PIL', 'lxml', 'pyxdg', 'markdown', 'html2text', 'pycrypto >= 2.6.1', 'python-potr'],
586
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
249 cmdclass={'install': CustomInstall},
6a718ede8be1 Fix coding style in setup.py.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 581
diff changeset
250 ) # XXX: wxpython doesn't work, it's managed with preinstall_check