summaryrefslogtreecommitdiff
path: root/common/setup.py
blob: 42bf272a4388004e3b1d128360ed428494ea69a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# -*- coding: utf-8 -*-
# setup.py
# Copyright (C) 2013 LEAP
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
"""
setup file for leap.soledad.common
"""
import re
from setuptools import setup
from setuptools import find_packages

import versioneer
versioneer.versionfile_source = 'src/leap/soledad/common/_version.py'
versioneer.versionfile_build = 'leap/soledad/common/_version.py'
versioneer.tag_prefix = ''  # tags are like 1.2.0
versioneer.parentdir_prefix = 'leap.soledad.common-'

from pkg import utils

trove_classifiers = (
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: "
    "GNU General Public License v3 or later (GPLv3+)",
    "Environment :: Console",
    "Operating System :: OS Independent",
    "Operating System :: POSIX",
    "Programming Language :: Python :: 2.6",
    "Programming Language :: Python :: 2.7",
    "Topic :: Database :: Front-Ends",
    "Topic :: Software Development :: Libraries :: Python Modules"
)

DOWNLOAD_BASE = ('https://github.com/leapcode/soledad/'
                 'archive/%s.tar.gz')
_versions = versioneer.get_versions()
VERSION = _versions['version']
VERSION_FULL = _versions['full']
DOWNLOAD_URL = ""

# get the short version for the download url
_version_short = re.findall('\d+\.\d+\.\d+', VERSION)
if len(_version_short) > 0:
    VERSION_SHORT = _version_short[0]
    DOWNLOAD_URL = DOWNLOAD_BASE % VERSION_SHORT

cmdclass = versioneer.get_cmdclass()


from setuptools import Command


class freeze_debianver(Command):
    """
    Freezes the version in a debian branch.
    To be used after merging the development branch onto the debian one.
    """
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        proceed = str(raw_input(
            "This will overwrite the file _version.py. Continue? [y/N] "))
        if proceed != "y":
            print("He. You scared. Aborting.")
            return
        template = r"""
# This file was generated by the `freeze_debianver` command in setup.py
# Using 'versioneer.py' (0.7+) from
# revision-control system data, or from the parent directory name of an
# unpacked source archive. Distribution tarballs contain a pre-generated copy
# of this file.

version_version = '{version}'
version_full = '{version_full}'
"""
        templatefun = r"""

def get_versions(default={}, verbose=False):
        return {'version': version_version, 'full': version_full}
"""
        subst_template = template.format(
            version=VERSION_SHORT,
            version_full=VERSION_FULL) + templatefun
        with open(versioneer.versionfile_source, 'w') as f:
            f.write(subst_template)


from os import listdir
from os.path import realpath, dirname, isdir, join, isfile, basename
import json
import logging
import binascii


old_cmd_sdist = cmdclass["sdist"]


class cmd_sdist(old_cmd_sdist):
    """
    Generate 'src/leap/soledad/common/ddocs.py' which contains coush design
    documents scripts.
    """

    def run(self):
        old_cmd_sdist.run(self)
        self.build_ddocs_py()

    def build_ddocs_py(self):
        """
        Build couch design documents based on content from subdirectories in
        'src/leap/soledad/common/ddocs'.
        """
        prefix = join(
            dirname(realpath(__file__)),
            'src', 'leap', 'soledad', 'common')
        ddocs_prefix = join(prefix, 'ddocs')
        ddocs = {}

        # design docs are represented by subdirectories of `ddocs_prefix`
        for ddoc in [f for f in listdir(ddocs_prefix)
                if isdir(join(ddocs_prefix, f))]:

            ddocs[ddoc] = {'_id': '_design/%s' % ddoc}

            for t in ['views', 'lists', 'updates']:
                tdir = join(ddocs_prefix, ddoc, t)
                if isdir(tdir):

                    ddocs[ddoc][t] = {}

                    if t == 'views':  # handle views (with map/reduce functions)
                        for view in [f for f in listdir(tdir) \
                                if isdir(join(tdir, f))]:
                            # look for map.js and reduce.js
                            mapfile = join(tdir, view, 'map.js')
                            reducefile = join(tdir, view, 'reduce.js')
                            mapfun = None
                            reducefun = None
                            try:
                                with open(mapfile) as f:
                                    mapfun = f.read()
                            except IOError:
                                pass
                            try:
                                with open(reducefile) as f:
                                    reducefun = f.read()
                            except IOError:
                                pass
                            ddocs[ddoc]['views'][view] = {}

                            if mapfun is not None:
                                ddocs[ddoc]['views'][view]['map'] = mapfun
                            if reducefun is not None:
                                ddocs[ddoc]['views'][view]['reduce'] = reducefun

                    else:  # handle lists, updates, etc
                        for fun in [f for f in listdir(tdir) \
                                if isfile(join(tdir, f))]:
                            funfile = join(tdir, fun)
                            funname = basename(funfile).replace('.js', '')
                            try:
                                with open(funfile) as f:
                                    ddocs[ddoc][t][funname] = f.read()
                            except IOError:
                                pass
        # write file containing design docs strings
        with open(join(prefix, 'ddocs.py'), 'w') as f:
            for ddoc in ddocs:
                f.write(
                    "%s = '%s'\n" %
                    (ddoc, binascii.b2a_base64(json.dumps(ddocs[ddoc]))[:-1]))


cmdclass["freeze_debianver"] = freeze_debianver

# XXX add ref to docs

setup(
    name='leap.soledad.common',
    version=VERSION,
    cmdclass=cmdclass,
    url='https://leap.se/',
    download_url=DOWNLOAD_URL,
    license='GPLv3+',
    description='Synchronization of locally encrypted data among devices '
                '(common files).',
    author='The LEAP Encryption Access Project',
    author_email='info@leap.se',
    maintainer='Kali Kaneko',
    maintainer_email='kali@leap.se',
    long_description=(
        "Soledad is the part of LEAP that allows application data to be "
        "securely shared among devices. It provides, to other parts of the "
        "LEAP project, an API for data storage and sync."
    ),
    classifiers=trove_classifiers,
    namespace_packages=["leap", "leap.soledad"],
    packages=find_packages('src', exclude=['leap.soledad.common.tests']),
    package_dir={'': 'src'},
    test_suite='leap.soledad.common.tests',
    install_requires=utils.parse_requirements(),
    tests_require=utils.parse_requirements(
        reqfiles=['pkg/requirements-testing.pip']),
    extras_require={
        'couchdb': ['couchdb'],
    },
)