annotate kallithea/__init__.py @ 4219:24498ba2fbec kallithea-2.2.5-rebrand

SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name. kallithea.SETTINGS_PREFIX is a variable string used as a prefix for specific external identifiers, such as database table names (and likely later form fields), so that the name of the project need not necessarily be encoded into data. This setting is configurable so that compatibility with old, similar databases can be maintained at the users' request.
author Bradley M. Kuhn <bkuhn@sfconservancy.org>
date Fri, 23 May 2014 17:36:09 -0400
parents 24c0d584ba86
children 56dadd0e5cf7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
807
e8c9ff1da9ba added revision into version for beta
Marcin Kuzminski <marcin@python-works.com>
parents: 710
diff changeset
1 # -*- coding: utf-8 -*-
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1205
diff changeset
2 # This program is free software: you can redistribute it and/or modify
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1205
diff changeset
3 # it under the terms of the GNU General Public License as published by
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1205
diff changeset
4 # the Free Software Foundation, either version 3 of the License, or
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1205
diff changeset
5 # (at your option) any later version.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1194
diff changeset
6 #
252
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 246
diff changeset
7 # This program is distributed in the hope that it will be useful,
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 246
diff changeset
8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 246
diff changeset
9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 246
diff changeset
10 # GNU General Public License for more details.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1194
diff changeset
11 #
252
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 246
diff changeset
12 # You should have received a copy of the GNU General Public License
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1205
diff changeset
13 # along with this program. If not, see <http://www.gnu.org/licenses/>.
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
14 """
4186
7e5f8c12a3fc First step in two-part process to rename directories to kallithea.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
15 kallithea.__init__
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
16 ~~~~~~~~~~~~~~~~~~
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
17
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4211
diff changeset
18 Kallithea, a web based repository management based on pylons
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
19 versioning implementation: http://www.python.org/dev/peps/pep-0386/
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
20
4211
1948ede028ef RhodeCode GmbH is not the sole author of this work
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4208
diff changeset
21 This file was forked by the Kallithea project in July 2014.
1948ede028ef RhodeCode GmbH is not the sole author of this work
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4208
diff changeset
22 Original author and date, and relevant copyright and licensing information is below:
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
23 :created_on: Apr 9, 2010
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
24 :author: marcink
4219
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
25 :copyright: (c) 2013 RhodeCode GmbH, (C) 2014 Bradley M. Kuhn, and others.
4208
ad38f9f93b3b Correct licensing information in individual files.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4187
diff changeset
26 :license: GPLv3, see LICENSE.md for more details.
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
27 """
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
28
1964
b1ad9efeec14 fixed requires files, added distinction on win vs other platforms
Marcin Kuzminski <marcin@python-works.com>
parents: 1903
diff changeset
29 import sys
1118
b0e2c949c34b Fixed Windows installation based on work of Mantis406 fork: "Replace py-bcrypt to make Windows installation easier"
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
30 import platform
185
3380ca40cdba added version generation to pylons_app and showed it into template. Propagated baseController with some data for acces into each controller. Fixed simplehg middleware to get proper name of application
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
31
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
32 VERSION = (2, 2, 5)
3797
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
33 BACKENDS = {
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
34 'hg': 'Mercurial repository',
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
35 'git': 'Git repository',
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
36 }
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
37
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
38 CELERY_ON = False
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
39 CELERY_EAGER = False
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
40
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
41 # link to config for pylons
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
42 CONFIG = {}
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
43
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
44 # Linked module for extensions
d7488551578e synced vcs with upstream
Marcin Kuzminski <marcin@python-works.com>
parents: 3714
diff changeset
45 EXTENSIONS = {}
2136
b70721d03e84 pep386 versioning
Marcin Kuzminski <marcin@python-works.com>
parents: 2135
diff changeset
46
4219
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
47 # SETTINGS_PREFIX is the prefix to use for form fields and database table names.
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
48
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
49 # Ideally, SETTINGS_PREFIX would be in an ini file of some sort instead of
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
50 # in this code. However, since this is used in kallithea/model/db.py as
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
51 # part of the database initialization in code that typically runs before
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
52 # CONFIG (above) is populated with settings from the ini file, it's instead
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
53 # hard-coded herein.
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
54
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
55 SETTINGS_PREFIX = "kallithea_"
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
56 # NOTE: If you want compatibility with a database that was originally created
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
57 # for use with the Rhodecode software product, changing SETTINGS_PREFIX to
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
58 # "rhodecode_" might work to make the old database and forms compatible with
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
59 # this application.
24498ba2fbec SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4212
diff changeset
60
2136
b70721d03e84 pep386 versioning
Marcin Kuzminski <marcin@python-works.com>
parents: 2135
diff changeset
61 try:
4186
7e5f8c12a3fc First step in two-part process to rename directories to kallithea.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
62 from kallithea.lib import get_current_revision
3960
5293d4bbb1ea Merged dev into stable/default/master branch
Marcin Kuzminski <marcin@python-works.com>
parents: 3857 3906
diff changeset
63 _rev = get_current_revision(quiet=True)
2171
28d9893d6a23 add dev version only for beta
Marcin Kuzminski <marcin@python-works.com>
parents: 2170
diff changeset
64 if _rev and len(VERSION) > 3:
3702
a79bb3277b32 bump version of development
Marcin Kuzminski <marcin@python-works.com>
parents: 3699
diff changeset
65 VERSION += ('%s' % _rev[0],)
2136
b70721d03e84 pep386 versioning
Marcin Kuzminski <marcin@python-works.com>
parents: 2135
diff changeset
66 except ImportError:
b70721d03e84 pep386 versioning
Marcin Kuzminski <marcin@python-works.com>
parents: 2135
diff changeset
67 pass
b70721d03e84 pep386 versioning
Marcin Kuzminski <marcin@python-works.com>
parents: 2135
diff changeset
68
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
69 __version__ = ('.'.join((str(each) for each in VERSION[:3])))
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
70 __dbversion__ = 31 # defines current db version for migrations
1118
b0e2c949c34b Fixed Windows installation based on work of Mantis406 fork: "Replace py-bcrypt to make Windows installation easier"
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
71 __platform__ = platform.system()
1205
f4807acf643d added __license__ into main of rhodecode, PEP8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
72 __license__ = 'GPLv3'
1964
b1ad9efeec14 fixed requires files, added distinction on win vs other platforms
Marcin Kuzminski <marcin@python-works.com>
parents: 1903
diff changeset
73 __py_version__ = sys.version_info
4211
1948ede028ef RhodeCode GmbH is not the sole author of this work
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4208
diff changeset
74 __author__ = "Various Authors"
4184
48ad84558fb4 Change project URL - use kallithea-scm.org
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4116
diff changeset
75 __url__ = 'https://kallithea-scm.org/'
185
3380ca40cdba added version generation to pylons_app and showed it into template. Propagated baseController with some data for acces into each controller. Fixed simplehg middleware to get proper name of application
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
76
3892
3a1cf70e0f42 Fix check statements from () which had no effect really
Marcin Kuzminski <marcin@python-works.com>
parents: 3797
diff changeset
77 is_windows = __platform__ in ['Windows']
2634
4b17216f2110 Deprecated validation of operating system, we just care if it's windows, let approve all other
Marcin Kuzminski <marcin@python-works.com>
parents: 2563
diff changeset
78 is_unix = not is_windows
4116
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
79
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
80 if len(VERSION) > 3:
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
81 __version__ += '.'+VERSION[3]
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
82
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
83 if len(VERSION) > 4:
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
84 __version__ += VERSION[4]
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
85 else:
ffd45b185016 Imported some of the GPLv3'd changes from RhodeCode v2.2.5.
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3972
diff changeset
86 __version__ += '0'