Devops: move package into the src/ subdirectory (#119)

This structure is what is recommended by the Python documentation: https://packaging.python.org/en/latest/tutorials/packaging-projects/#creating-the-package-files There are a number of benefits for this structure and will prevent a variety of problems with package installations. As a result, many important packages in the Python ecosystem have started to adopt this package structure.
aiidateam · Oct 13, 2022 · 37538d0 · 37538d0
1 parent 237fbe4
commit 37538d0
Show file tree

Hide file tree

Showing 17 changed files with 1 addition and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -228,7 +228,7 @@ def run_apidoc(app):
     source_dir = Path(os.path.abspath(__file__)).parent
     apidoc_dir = source_dir / 'apidoc'
     apidoc_dir.mkdir(exist_ok=True)
-    package_dir = source_dir.parent.parent / 'kiwipy'
+    package_dir = source_dir.parent.parent / 'src' / 'kiwipy'
 
     # we write to a temporary folder first then only move across files that have changed
     # this ensures that document rebuilds are not triggered every time (due to change in file mtime)

diff --git a/kiwipy/__init__.py → src/kiwipy/__init__.py b/kiwipy/__init__.py → src/kiwipy/__init__.py
diff --git a/kiwipy/communicate.py → src/kiwipy/communicate.py b/kiwipy/communicate.py → src/kiwipy/communicate.py
diff --git a/kiwipy/communications.py → src/kiwipy/communications.py b/kiwipy/communications.py → src/kiwipy/communications.py
diff --git a/kiwipy/exceptions.py → src/kiwipy/exceptions.py b/kiwipy/exceptions.py → src/kiwipy/exceptions.py
diff --git a/kiwipy/filters.py → src/kiwipy/filters.py b/kiwipy/filters.py → src/kiwipy/filters.py
diff --git a/kiwipy/futures.py → src/kiwipy/futures.py b/kiwipy/futures.py → src/kiwipy/futures.py
diff --git a/kiwipy/local.py → src/kiwipy/local.py b/kiwipy/local.py → src/kiwipy/local.py
diff --git a/kiwipy/rmq/__init__.py → src/kiwipy/rmq/__init__.py b/kiwipy/rmq/__init__.py → src/kiwipy/rmq/__init__.py
diff --git a/kiwipy/rmq/communicator.py → src/kiwipy/rmq/communicator.py b/kiwipy/rmq/communicator.py → src/kiwipy/rmq/communicator.py
diff --git a/kiwipy/rmq/configure.py → src/kiwipy/rmq/configure.py b/kiwipy/rmq/configure.py → src/kiwipy/rmq/configure.py
diff --git a/kiwipy/rmq/defaults.py → src/kiwipy/rmq/defaults.py b/kiwipy/rmq/defaults.py → src/kiwipy/rmq/defaults.py
diff --git a/kiwipy/rmq/messages.py → src/kiwipy/rmq/messages.py b/kiwipy/rmq/messages.py → src/kiwipy/rmq/messages.py
diff --git a/kiwipy/rmq/tasks.py → src/kiwipy/rmq/tasks.py b/kiwipy/rmq/tasks.py → src/kiwipy/rmq/tasks.py
diff --git a/kiwipy/rmq/threadcomms.py → src/kiwipy/rmq/threadcomms.py b/kiwipy/rmq/threadcomms.py → src/kiwipy/rmq/threadcomms.py
diff --git a/kiwipy/rmq/utils.py → src/kiwipy/rmq/utils.py b/kiwipy/rmq/utils.py → src/kiwipy/rmq/utils.py
diff --git a/kiwipy/utils.py → src/kiwipy/utils.py b/kiwipy/utils.py → src/kiwipy/utils.py