Merge pull request #1016 from ThomasWaldmann/move-to-src

move to src/

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-source = borg
+source = src/borg
 omit =
     */borg/__init__.py
     */borg/__main__.py

.gitignore

@@ -11,13 +11,14 @@ crypto.c
 platform_darwin.c
 platform_freebsd.c
 platform_linux.c
+platform_posix.c
 *.egg-info
 *.pyc
 *.pyo
 *.so
 .idea/
 .cache/
-borg/_version.py
+src/borg/_version.py
 borg.build/
 borg.dist/
 borg.exe

MANIFEST.in

@@ -1,9 +1,10 @@
 include README.rst AUTHORS LICENSE CHANGES.rst MANIFEST.in
-recursive-include borg *.pyx
+graft src
+recursive-exclude src *.pyc
+recursive-exclude src *.pyo
 recursive-include docs *
 recursive-exclude docs *.pyc
 recursive-exclude docs *.pyo
 prune docs/_build
 prune .travis
 exclude .coveragerc .gitattributes .gitignore .travis.yml Vagrantfile
-include borg/_version.py

conftest.py

@@ -1,25 +1,3 @@
-import os.path
-import sys
-
-# This is a hack to fix path problems because "borg" (the package) is in the source root.
-# When importing the conftest an "import borg" can incorrectly import the borg from the
-# source root instead of the one installed in the environment.
-# The workaround is to remove entries pointing there from the path and check whether "borg"
-# is still importable. If it is not, then it has not been installed in the environment
-# and the entries are put back.
-#
-# TODO: After moving the package to src/: remove this.
-
-original_path = list(sys.path)
-for entry in original_path:
-    if entry == '' or entry == os.path.dirname(__file__):
-        sys.path.remove(entry)
-
-try:
-    import borg
-except ImportError:
-    sys.path = original_path
-
 from borg.logger import setup_logging
 
 # Ensure that the loggers exist for all tests

setup.py

@@ -38,18 +38,17 @@ if sys.platform.startswith('freebsd'):
     # llfuse 0.41.1 is the latest release that actually builds on freebsd:
     extras_require['fuse'] = ['llfuse==0.41.1', ]
 
-from setuptools import setup, Extension
+from setuptools import setup, find_packages, Extension
 from setuptools.command.sdist import sdist
 
-
-compress_source = 'borg/compress.pyx'
-crypto_source = 'borg/crypto.pyx'
-chunker_source = 'borg/chunker.pyx'
-hashindex_source = 'borg/hashindex.pyx'
-platform_posix_source = 'borg/platform_posix.pyx'
-platform_linux_source = 'borg/platform_linux.pyx'
-platform_darwin_source = 'borg/platform_darwin.pyx'
-platform_freebsd_source = 'borg/platform_freebsd.pyx'
+compress_source = 'src/borg/compress.pyx'
+crypto_source = 'src/borg/crypto.pyx'
+chunker_source = 'src/borg/chunker.pyx'
+hashindex_source = 'src/borg/hashindex.pyx'
+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'
 
 try:
     from Cython.Distutils import build_ext
@@ -57,20 +56,20 @@ try:
 
     class Sdist(sdist):
         def __init__(self, *args, **kwargs):
-            for src in glob('borg/*.pyx'):
+            for src in glob('src/borg/*.pyx'):
                 cython_compiler.compile(src, cython_compiler.default_options)
             super().__init__(*args, **kwargs)
 
         def make_distribution(self):
             self.filelist.extend([
-                'borg/compress.c',
-                'borg/crypto.c',
-                'borg/chunker.c', 'borg/_chunker.c',
-                'borg/hashindex.c', 'borg/_hashindex.c',
-                'borg/platform_posix.c',
-                'borg/platform_linux.c',
-                'borg/platform_freebsd.c',
-                'borg/platform_darwin.c',
+                'src/borg/compress.c',
+                'src/borg/crypto.c',
+                'src/borg/chunker.c', 'src/borg/_chunker.c',
+                'src/borg/hashindex.c', 'src/borg/_hashindex.c',
+                'src/borg/platform_posix.c',
+                'src/borg/platform_linux.c',
+                'src/borg/platform_freebsd.c',
+                'src/borg/platform_darwin.c',
             ])
             super().make_distribution()
 
@@ -269,7 +268,7 @@ class build_api(Command):
 API Documentation
 =================
 """)
-            for mod in glob('borg/*.py') + glob('borg/*.pyx'):
+            for mod in glob('src/borg/*.py') + glob('src/borg/*.pyx'):
                 print("examining module %s" % mod)
                 mod = mod.replace('.pyx', '').replace('.py', '').replace('/', '.')
                 if "._" not in mod:
@@ -308,7 +307,7 @@ if not on_rtd:
 setup(
     name='borgbackup',
     use_scm_version={
-        'write_to': 'borg/_version.py',
+        'write_to': 'src/borg/_version.py',
     },
     author='The Borg Collective (see AUTHORS file)',
     author_email='borgbackup@python.org',
@@ -334,7 +333,10 @@ setup(
         'Topic :: Security :: Cryptography',
         'Topic :: System :: Archiving :: Backup',
     ],
-    packages=['borg', 'borg.testsuite', ],
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    include_package_data=True,
+    zip_safe=False,
     entry_points={
         'console_scripts': [
             'borg = borg.archiver:main',

tox.ini

@@ -5,13 +5,10 @@
 envlist = py{34,35,36},flake8
 
 [testenv]
-# Change dir to avoid import problem for cython code. The directory does
-# not really matter, should be just different from the toplevel dir.
-changedir = {toxworkdir}
 deps =
      -rrequirements.d/development.txt
      attic
-commands = py.test --cov=borg --cov-config=../.coveragerc --benchmark-skip --pyargs {posargs:borg.testsuite}
+commands = py.test --cov=borg --cov-config=.coveragerc --benchmark-skip --pyargs {posargs:borg.testsuite}
 # fakeroot -u needs some env vars:
 passenv = *