2019-03-14 02:28:59 +03:00
|
|
|
# borgbackup - main setup code (see also other setup_*.py files)
|
|
|
|
|
2011-08-20 20:11:23 +04:00
|
|
|
import os
|
2010-10-30 15:24:23 +04:00
|
|
|
import sys
|
2019-03-13 05:01:00 +03:00
|
|
|
from collections import defaultdict
|
2011-08-20 20:11:23 +04:00
|
|
|
from glob import glob
|
2011-11-07 00:40:29 +04:00
|
|
|
|
2018-04-28 19:06:10 +03:00
|
|
|
try:
|
|
|
|
import multiprocessing
|
|
|
|
except ImportError:
|
|
|
|
multiprocessing = None
|
|
|
|
|
|
|
|
from distutils.command.clean import clean
|
|
|
|
from setuptools.command.build_ext import build_ext
|
|
|
|
from setuptools import setup, find_packages, Extension
|
|
|
|
from setuptools.command.sdist import sdist
|
|
|
|
|
|
|
|
try:
|
|
|
|
from Cython.Build import cythonize
|
|
|
|
except ImportError:
|
|
|
|
cythonize = None
|
2015-10-08 02:55:56 +03:00
|
|
|
|
2019-03-14 02:15:17 +03:00
|
|
|
import setup_compress
|
2019-03-12 05:15:59 +03:00
|
|
|
import setup_crypto
|
2018-06-12 22:06:01 +03:00
|
|
|
import setup_docs
|
2017-12-05 06:16:25 +03:00
|
|
|
|
2019-03-15 23:23:46 +03:00
|
|
|
# How the build process finds the system libs / uses the bundled code:
|
|
|
|
#
|
|
|
|
# 1. it will try to use (system) libs (see 1.1. and 1.2.),
|
|
|
|
# except if you use these env vars to force using the bundled code:
|
|
|
|
# BORG_USE_BUNDLED_XXX undefined --> try using system lib
|
|
|
|
# BORG_USE_BUNDLED_XXX=YES --> use the bundled code
|
|
|
|
# Note: do not use =NO, that is not supported!
|
|
|
|
# 1.1. if BORG_LIBXXX_PREFIX is set, it will use headers and libs from there.
|
|
|
|
# 1.2. if not and pkg-config can locate the lib, the lib located by
|
|
|
|
# pkg-config will be used. We use the pkg-config tool via the pkgconfig
|
|
|
|
# python package, which must be installed before invoking setup.py.
|
|
|
|
# if pkgconfig is not installed, this step is skipped.
|
|
|
|
# 2. if no system lib could be located via 1.1. or 1.2., it will fall back
|
|
|
|
# to using the bundled code.
|
|
|
|
|
|
|
|
# OpenSSL is required as a (system) lib in any case as we do not bundle it.
|
|
|
|
# Thus, only step 1.1. and 1.2. apply to openssl (but not 1. and 2.).
|
|
|
|
# needed: openssl >=1.0.2 or >=1.1.0 (or compatible)
|
|
|
|
system_prefix_openssl = os.environ.get('BORG_OPENSSL_PREFIX')
|
|
|
|
|
|
|
|
# needed: blake2 (>= 0.98.1)
|
|
|
|
prefer_system_libb2 = not bool(os.environ.get('BORG_USE_BUNDLED_B2'))
|
|
|
|
system_prefix_libb2 = os.environ.get('BORG_LIBB2_PREFIX')
|
2017-12-15 08:35:20 +03:00
|
|
|
|
2019-03-15 21:54:33 +03:00
|
|
|
# needed: lz4 (>= 1.7.0 / r129)
|
|
|
|
prefer_system_liblz4 = not bool(os.environ.get('BORG_USE_BUNDLED_LZ4'))
|
2019-03-15 23:23:46 +03:00
|
|
|
system_prefix_liblz4 = os.environ.get('BORG_LIBLZ4_PREFIX')
|
2019-03-15 21:54:33 +03:00
|
|
|
|
|
|
|
# needed: zstd (>= 1.3.0)
|
|
|
|
prefer_system_libzstd = not bool(os.environ.get('BORG_USE_BUNDLED_ZSTD'))
|
2019-03-15 23:23:46 +03:00
|
|
|
system_prefix_libzstd = os.environ.get('BORG_LIBZSTD_PREFIX')
|
2017-12-17 05:06:12 +03:00
|
|
|
|
2018-04-28 19:06:10 +03:00
|
|
|
cpu_threads = multiprocessing.cpu_count() if multiprocessing else 1
|
|
|
|
|
2015-10-08 02:16:49 +03:00
|
|
|
# Are we building on ReadTheDocs?
|
2015-10-08 15:23:37 +03:00
|
|
|
on_rtd = os.environ.get('READTHEDOCS')
|
2015-10-08 02:16:49 +03:00
|
|
|
|
2017-07-29 12:55:26 +03:00
|
|
|
install_requires = [
|
2018-04-13 00:35:38 +03:00
|
|
|
# we are rather picky about msgpack versions, because a good working msgpack is
|
2019-02-05 04:37:22 +03:00
|
|
|
# very important for borg, see: https://github.com/borgbackup/borg/issues/3753
|
|
|
|
'msgpack >=0.5.6, <=0.6.1',
|
2019-02-03 01:52:16 +03:00
|
|
|
# Please note:
|
|
|
|
# using any other version is not supported by borg development and
|
|
|
|
# any feedback related to issues caused by this will be ignored.
|
2017-07-29 12:55:26 +03:00
|
|
|
]
|
2015-09-12 23:44:23 +03:00
|
|
|
|
2016-10-19 01:56:22 +03:00
|
|
|
# note for package maintainers: if you package borgbackup for distribution,
|
|
|
|
# please add llfuse as a *requirement* on all platforms that have a working
|
|
|
|
# llfuse package. "borg mount" needs llfuse to work.
|
|
|
|
# if you do not have llfuse, do not require it, most of borgbackup will work.
|
2016-02-07 21:03:32 +03:00
|
|
|
extras_require = {
|
2018-06-12 21:49:23 +03:00
|
|
|
# llfuse 1.x should work, llfuse 2.0 will break API
|
2018-06-12 05:29:16 +03:00
|
|
|
'fuse': [
|
2018-06-12 21:49:23 +03:00
|
|
|
'llfuse >=1.1, <2.0',
|
2018-06-12 05:29:16 +03:00
|
|
|
'llfuse >=1.3.4; python_version >="3.7"',
|
|
|
|
],
|
2016-02-07 21:03:32 +03:00
|
|
|
}
|
2015-07-12 16:07:24 +03:00
|
|
|
|
2016-05-05 21:59:53 +03:00
|
|
|
compress_source = 'src/borg/compress.pyx'
|
2017-05-02 20:05:27 +03:00
|
|
|
crypto_ll_source = 'src/borg/crypto/low_level.pyx'
|
2016-07-14 23:35:50 +03:00
|
|
|
crypto_helpers = 'src/borg/crypto/_crypto_helpers.c'
|
2017-05-02 19:52:36 +03:00
|
|
|
chunker_source = 'src/borg/chunker.pyx'
|
2016-05-05 21:59:53 +03:00
|
|
|
hashindex_source = 'src/borg/hashindex.pyx'
|
2016-11-30 14:43:28 +03:00
|
|
|
item_source = 'src/borg/item.pyx'
|
2017-06-01 00:17:27 +03:00
|
|
|
checksums_source = 'src/borg/algorithms/checksums.pyx'
|
2016-05-31 03:35:54 +03:00
|
|
|
platform_posix_source = 'src/borg/platform/posix.pyx'
|
|
|
|
platform_linux_source = 'src/borg/platform/linux.pyx'
|
|
|
|
platform_darwin_source = 'src/borg/platform/darwin.pyx'
|
|
|
|
platform_freebsd_source = 'src/borg/platform/freebsd.pyx'
|
|
|
|
|
|
|
|
cython_sources = [
|
|
|
|
compress_source,
|
2017-05-02 20:05:27 +03:00
|
|
|
crypto_ll_source,
|
2016-05-31 03:35:54 +03:00
|
|
|
chunker_source,
|
|
|
|
hashindex_source,
|
2016-11-30 14:43:28 +03:00
|
|
|
item_source,
|
2017-06-01 00:17:27 +03:00
|
|
|
checksums_source,
|
2016-05-31 03:35:54 +03:00
|
|
|
|
|
|
|
platform_posix_source,
|
|
|
|
platform_linux_source,
|
|
|
|
platform_freebsd_source,
|
|
|
|
platform_darwin_source,
|
|
|
|
]
|
2013-06-18 23:34:22 +04:00
|
|
|
|
2018-04-28 19:06:10 +03:00
|
|
|
if cythonize:
|
|
|
|
Sdist = sdist
|
|
|
|
else:
|
2015-08-22 15:58:06 +03:00
|
|
|
class Sdist(sdist):
|
2013-06-24 15:53:02 +04:00
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
raise Exception('Cython is required to run sdist')
|
|
|
|
|
2015-10-08 15:22:52 +03:00
|
|
|
if not on_rtd and not all(os.path.exists(path) for path in [
|
2017-06-01 00:17:27 +03:00
|
|
|
compress_source, crypto_ll_source, chunker_source, hashindex_source, item_source, checksums_source,
|
2016-05-20 23:48:57 +03:00
|
|
|
platform_posix_source, platform_linux_source, platform_freebsd_source, platform_darwin_source]):
|
2015-09-19 22:44:40 +03:00
|
|
|
raise ImportError('The GIT version of Borg needs Cython. Install Cython or use a released version.')
|
2014-03-11 01:50:38 +04:00
|
|
|
|
|
|
|
|
2017-06-01 00:17:27 +03:00
|
|
|
def rm(file):
|
|
|
|
try:
|
|
|
|
os.unlink(file)
|
|
|
|
print('rm', file)
|
|
|
|
except FileNotFoundError:
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
2017-05-25 18:55:42 +03:00
|
|
|
class Clean(clean):
|
|
|
|
def run(self):
|
|
|
|
super().run()
|
|
|
|
for source in cython_sources:
|
|
|
|
genc = source.replace('.pyx', '.c')
|
2017-06-01 00:17:27 +03:00
|
|
|
rm(genc)
|
2017-05-25 18:55:42 +03:00
|
|
|
compiled_glob = source.replace('.pyx', '.cpython*')
|
2017-06-01 00:17:27 +03:00
|
|
|
for compiled in sorted(glob(compiled_glob)):
|
|
|
|
rm(compiled)
|
2017-05-25 18:55:42 +03:00
|
|
|
|
2018-06-12 22:06:01 +03:00
|
|
|
|
2015-10-08 02:55:56 +03:00
|
|
|
cmdclass = {
|
|
|
|
'build_ext': build_ext,
|
2018-06-12 22:06:01 +03:00
|
|
|
'build_usage': setup_docs.build_usage,
|
|
|
|
'build_man': setup_docs.build_man,
|
2017-05-25 18:55:42 +03:00
|
|
|
'sdist': Sdist,
|
|
|
|
'clean': Clean,
|
2015-10-08 02:55:56 +03:00
|
|
|
}
|
2013-08-06 00:45:24 +04:00
|
|
|
|
2015-10-08 02:16:49 +03:00
|
|
|
ext_modules = []
|
|
|
|
if not on_rtd:
|
2019-03-13 05:01:00 +03:00
|
|
|
|
|
|
|
def members_appended(*ds):
|
|
|
|
result = defaultdict(list)
|
|
|
|
for d in ds:
|
|
|
|
for k, v in d.items():
|
|
|
|
assert isinstance(v, list)
|
|
|
|
result[k].extend(v)
|
|
|
|
return result
|
|
|
|
|
2019-03-14 01:59:04 +03:00
|
|
|
try:
|
|
|
|
import pkgconfig as pc
|
|
|
|
except ImportError:
|
|
|
|
print('Warning: can not import pkgconfig python package.')
|
|
|
|
pc = None
|
|
|
|
|
2019-03-13 05:01:00 +03:00
|
|
|
crypto_ext_kwargs = members_appended(
|
|
|
|
dict(sources=[crypto_ll_source, crypto_helpers]),
|
2019-03-15 23:23:46 +03:00
|
|
|
setup_crypto.crypto_ext_kwargs(pc, system_prefix_openssl),
|
|
|
|
setup_crypto.b2_ext_kwargs(pc, prefer_system_libb2, system_prefix_libb2),
|
2019-03-13 05:01:00 +03:00
|
|
|
)
|
|
|
|
|
2019-03-13 16:53:18 +03:00
|
|
|
compress_ext_kwargs = members_appended(
|
|
|
|
dict(sources=[compress_source]),
|
2019-03-15 23:23:46 +03:00
|
|
|
setup_compress.lz4_ext_kwargs(pc, prefer_system_liblz4, system_prefix_liblz4),
|
|
|
|
setup_compress.zstd_ext_kwargs(pc, prefer_system_libzstd, system_prefix_libzstd,
|
|
|
|
multithreaded=False, legacy=False),
|
2019-03-13 16:53:18 +03:00
|
|
|
)
|
|
|
|
|
2015-10-08 02:16:49 +03:00
|
|
|
ext_modules += [
|
2017-12-17 05:06:12 +03:00
|
|
|
Extension('borg.crypto.low_level', **crypto_ext_kwargs),
|
2019-03-13 16:53:18 +03:00
|
|
|
Extension('borg.compress', **compress_ext_kwargs),
|
2017-12-05 06:16:25 +03:00
|
|
|
Extension('borg.hashindex', [hashindex_source]),
|
|
|
|
Extension('borg.item', [item_source]),
|
|
|
|
Extension('borg.chunker', [chunker_source]),
|
|
|
|
Extension('borg.algorithms.checksums', [checksums_source]),
|
|
|
|
]
|
2018-04-28 19:06:10 +03:00
|
|
|
|
|
|
|
posix_ext = Extension('borg.platform.posix', [platform_posix_source])
|
|
|
|
linux_ext = Extension('borg.platform.linux', [platform_linux_source], libraries=['acl'])
|
|
|
|
freebsd_ext = Extension('borg.platform.freebsd', [platform_freebsd_source])
|
|
|
|
darwin_ext = Extension('borg.platform.darwin', [platform_darwin_source])
|
|
|
|
|
2017-01-14 16:48:49 +03:00
|
|
|
if not sys.platform.startswith(('win32', )):
|
2018-04-28 19:06:10 +03:00
|
|
|
ext_modules.append(posix_ext)
|
2015-12-15 03:08:35 +03:00
|
|
|
if sys.platform == 'linux':
|
2018-04-28 19:06:10 +03:00
|
|
|
ext_modules.append(linux_ext)
|
2015-10-08 02:16:49 +03:00
|
|
|
elif sys.platform.startswith('freebsd'):
|
2018-04-28 19:06:10 +03:00
|
|
|
ext_modules.append(freebsd_ext)
|
2015-10-08 02:16:49 +03:00
|
|
|
elif sys.platform == 'darwin':
|
2018-04-28 19:06:10 +03:00
|
|
|
ext_modules.append(darwin_ext)
|
|
|
|
|
|
|
|
# sometimes there's no need to cythonize
|
|
|
|
# this breaks chained commands like 'clean sdist'
|
|
|
|
cythonizing = len(sys.argv) > 1 and sys.argv[1] not in ('clean', 'egg_info', '--help-commands', '--version') \
|
|
|
|
and '--help' not in sys.argv[1:]
|
|
|
|
|
|
|
|
if cythonize and cythonizing:
|
2018-12-15 20:12:10 +03:00
|
|
|
cython_opts = dict(
|
|
|
|
# compile .pyx extensions to .c in parallel
|
|
|
|
nthreads=cpu_threads + 1,
|
|
|
|
# default language_level will be '3str' starting from Cython 3.0.0,
|
|
|
|
# but old cython versions (< 0.29) do not know that, thus we use 3 for now.
|
|
|
|
compiler_directives={'language_level': 3},
|
|
|
|
)
|
|
|
|
cythonize([posix_ext, linux_ext, freebsd_ext, darwin_ext], **cython_opts)
|
|
|
|
ext_modules = cythonize(ext_modules, **cython_opts)
|
2014-04-13 22:26:46 +04:00
|
|
|
|
2019-03-14 02:40:30 +03:00
|
|
|
|
2013-06-24 15:53:02 +04:00
|
|
|
setup(
|
2015-05-09 19:40:55 +03:00
|
|
|
name='borgbackup',
|
2015-08-22 16:54:40 +03:00
|
|
|
use_scm_version={
|
2016-05-05 21:59:53 +03:00
|
|
|
'write_to': 'src/borg/_version.py',
|
2015-08-22 16:54:40 +03:00
|
|
|
},
|
2015-05-09 19:40:55 +03:00
|
|
|
author='The Borg Collective (see AUTHORS file)',
|
2015-12-08 12:12:15 +03:00
|
|
|
author_email='borgbackup@python.org',
|
2016-04-29 04:19:27 +03:00
|
|
|
url='https://borgbackup.readthedocs.io/',
|
2015-05-09 19:40:55 +03:00
|
|
|
description='Deduplicated, encrypted, authenticated and compressed backups',
|
2019-03-14 02:40:30 +03:00
|
|
|
long_description=setup_docs.long_desc_from_readme(),
|
2013-06-24 15:53:02 +04:00
|
|
|
license='BSD',
|
2015-09-16 12:44:53 +03:00
|
|
|
platforms=['Linux', 'MacOS X', 'FreeBSD', 'OpenBSD', 'NetBSD', ],
|
2013-06-24 15:53:02 +04:00
|
|
|
classifiers=[
|
2019-02-27 00:39:27 +03:00
|
|
|
'Development Status :: 3 - Alpha',
|
2013-06-24 15:53:02 +04:00
|
|
|
'Environment :: Console',
|
|
|
|
'Intended Audience :: System Administrators',
|
|
|
|
'License :: OSI Approved :: BSD License',
|
2013-07-28 16:55:48 +04:00
|
|
|
'Operating System :: POSIX :: BSD :: FreeBSD',
|
2015-09-16 12:44:53 +03:00
|
|
|
'Operating System :: POSIX :: BSD :: OpenBSD',
|
|
|
|
'Operating System :: POSIX :: BSD :: NetBSD',
|
2013-06-28 00:10:15 +04:00
|
|
|
'Operating System :: MacOS :: MacOS X',
|
|
|
|
'Operating System :: POSIX :: Linux',
|
2013-06-24 15:53:02 +04:00
|
|
|
'Programming Language :: Python',
|
2015-05-14 13:04:38 +03:00
|
|
|
'Programming Language :: Python :: 3',
|
2018-12-11 02:53:43 +03:00
|
|
|
'Programming Language :: Python :: 3.5',
|
2017-01-04 03:02:25 +03:00
|
|
|
'Programming Language :: Python :: 3.6',
|
2018-08-06 18:48:27 +03:00
|
|
|
'Programming Language :: Python :: 3.7',
|
2013-06-24 15:53:02 +04:00
|
|
|
'Topic :: Security :: Cryptography',
|
|
|
|
'Topic :: System :: Archiving :: Backup',
|
|
|
|
],
|
2016-05-05 21:59:53 +03:00
|
|
|
packages=find_packages('src'),
|
|
|
|
package_dir={'': 'src'},
|
|
|
|
zip_safe=False,
|
2015-07-12 16:00:47 +03:00
|
|
|
entry_points={
|
|
|
|
'console_scripts': [
|
|
|
|
'borg = borg.archiver:main',
|
2016-03-17 03:40:17 +03:00
|
|
|
'borgfs = borg.archiver:main',
|
2015-07-12 16:00:47 +03:00
|
|
|
]
|
|
|
|
},
|
2017-11-24 07:00:23 +03:00
|
|
|
# See also the MANIFEST.in file.
|
|
|
|
# We want to install all the files in the package directories...
|
2017-06-26 23:23:02 +03:00
|
|
|
include_package_data=True,
|
2017-11-24 07:00:23 +03:00
|
|
|
# ...except the source files which have been compiled (C extensions):
|
|
|
|
exclude_package_data={
|
|
|
|
'': ['*.c', '*.h', '*.pyx', ],
|
2017-02-08 02:22:37 +03:00
|
|
|
},
|
2013-08-06 00:45:24 +04:00
|
|
|
cmdclass=cmdclass,
|
2014-04-13 22:26:46 +04:00
|
|
|
ext_modules=ext_modules,
|
2015-08-22 15:58:06 +03:00
|
|
|
setup_requires=['setuptools_scm>=1.7'],
|
2015-09-12 23:44:23 +03:00
|
|
|
install_requires=install_requires,
|
2016-02-07 21:03:32 +03:00
|
|
|
extras_require=extras_require,
|
2018-12-11 02:53:43 +03:00
|
|
|
python_requires='>=3.5',
|
2013-06-24 15:53:02 +04:00
|
|
|
)
|