From ed6cc50c7dd57c3d2049aee9f01833a1736db9d9 Mon Sep 17 00:00:00 2001 From: Sebastiaan Huber Date: Fri, 8 Apr 2022 17:19:26 +0200 Subject: [PATCH] Devops: move package into the `src/` subdirectory 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. --- docs/source/conf.py | 2 +- {plumpy => src/plumpy}/__init__.py | 0 {plumpy => src/plumpy}/base/__init__.py | 0 {plumpy => src/plumpy}/base/state_machine.py | 0 {plumpy => src/plumpy}/base/utils.py | 0 {plumpy => src/plumpy}/communications.py | 0 {plumpy => src/plumpy}/events.py | 0 {plumpy => src/plumpy}/exceptions.py | 0 {plumpy => src/plumpy}/futures.py | 0 {plumpy => src/plumpy}/lang.py | 0 {plumpy => src/plumpy}/loaders.py | 0 {plumpy => src/plumpy}/mixins.py | 0 {plumpy => src/plumpy}/persistence.py | 0 {plumpy => src/plumpy}/ports.py | 0 {plumpy => src/plumpy}/process_comms.py | 0 {plumpy => src/plumpy}/process_listener.py | 0 {plumpy => src/plumpy}/process_spec.py | 0 {plumpy => src/plumpy}/process_states.py | 0 {plumpy => src/plumpy}/processes.py | 0 {plumpy => src/plumpy}/py.typed | 0 {plumpy => src/plumpy}/settings.py | 0 {plumpy => src/plumpy}/utils.py | 0 {plumpy => src/plumpy}/workchains.py | 0 23 files changed, 1 insertion(+), 1 deletion(-) rename {plumpy => src/plumpy}/__init__.py (100%) rename {plumpy => src/plumpy}/base/__init__.py (100%) rename {plumpy => src/plumpy}/base/state_machine.py (100%) rename {plumpy => src/plumpy}/base/utils.py (100%) rename {plumpy => src/plumpy}/communications.py (100%) rename {plumpy => src/plumpy}/events.py (100%) rename {plumpy => src/plumpy}/exceptions.py (100%) rename {plumpy => src/plumpy}/futures.py (100%) rename {plumpy => src/plumpy}/lang.py (100%) rename {plumpy => src/plumpy}/loaders.py (100%) rename {plumpy => src/plumpy}/mixins.py (100%) rename {plumpy => src/plumpy}/persistence.py (100%) rename {plumpy => src/plumpy}/ports.py (100%) rename {plumpy => src/plumpy}/process_comms.py (100%) rename {plumpy => src/plumpy}/process_listener.py (100%) rename {plumpy => src/plumpy}/process_spec.py (100%) rename {plumpy => src/plumpy}/process_states.py (100%) rename {plumpy => src/plumpy}/processes.py (100%) rename {plumpy => src/plumpy}/py.typed (100%) rename {plumpy => src/plumpy}/settings.py (100%) rename {plumpy => src/plumpy}/utils.py (100%) rename {plumpy => src/plumpy}/workchains.py (100%) diff --git a/docs/source/conf.py b/docs/source/conf.py index 841a8916..a1c6f26e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -106,7 +106,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 / 'plumpy' + package_dir = source_dir.parent.parent / 'src' / 'plumpy' # 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/plumpy/__init__.py b/src/plumpy/__init__.py similarity index 100% rename from plumpy/__init__.py rename to src/plumpy/__init__.py diff --git a/plumpy/base/__init__.py b/src/plumpy/base/__init__.py similarity index 100% rename from plumpy/base/__init__.py rename to src/plumpy/base/__init__.py diff --git a/plumpy/base/state_machine.py b/src/plumpy/base/state_machine.py similarity index 100% rename from plumpy/base/state_machine.py rename to src/plumpy/base/state_machine.py diff --git a/plumpy/base/utils.py b/src/plumpy/base/utils.py similarity index 100% rename from plumpy/base/utils.py rename to src/plumpy/base/utils.py diff --git a/plumpy/communications.py b/src/plumpy/communications.py similarity index 100% rename from plumpy/communications.py rename to src/plumpy/communications.py diff --git a/plumpy/events.py b/src/plumpy/events.py similarity index 100% rename from plumpy/events.py rename to src/plumpy/events.py diff --git a/plumpy/exceptions.py b/src/plumpy/exceptions.py similarity index 100% rename from plumpy/exceptions.py rename to src/plumpy/exceptions.py diff --git a/plumpy/futures.py b/src/plumpy/futures.py similarity index 100% rename from plumpy/futures.py rename to src/plumpy/futures.py diff --git a/plumpy/lang.py b/src/plumpy/lang.py similarity index 100% rename from plumpy/lang.py rename to src/plumpy/lang.py diff --git a/plumpy/loaders.py b/src/plumpy/loaders.py similarity index 100% rename from plumpy/loaders.py rename to src/plumpy/loaders.py diff --git a/plumpy/mixins.py b/src/plumpy/mixins.py similarity index 100% rename from plumpy/mixins.py rename to src/plumpy/mixins.py diff --git a/plumpy/persistence.py b/src/plumpy/persistence.py similarity index 100% rename from plumpy/persistence.py rename to src/plumpy/persistence.py diff --git a/plumpy/ports.py b/src/plumpy/ports.py similarity index 100% rename from plumpy/ports.py rename to src/plumpy/ports.py diff --git a/plumpy/process_comms.py b/src/plumpy/process_comms.py similarity index 100% rename from plumpy/process_comms.py rename to src/plumpy/process_comms.py diff --git a/plumpy/process_listener.py b/src/plumpy/process_listener.py similarity index 100% rename from plumpy/process_listener.py rename to src/plumpy/process_listener.py diff --git a/plumpy/process_spec.py b/src/plumpy/process_spec.py similarity index 100% rename from plumpy/process_spec.py rename to src/plumpy/process_spec.py diff --git a/plumpy/process_states.py b/src/plumpy/process_states.py similarity index 100% rename from plumpy/process_states.py rename to src/plumpy/process_states.py diff --git a/plumpy/processes.py b/src/plumpy/processes.py similarity index 100% rename from plumpy/processes.py rename to src/plumpy/processes.py diff --git a/plumpy/py.typed b/src/plumpy/py.typed similarity index 100% rename from plumpy/py.typed rename to src/plumpy/py.typed diff --git a/plumpy/settings.py b/src/plumpy/settings.py similarity index 100% rename from plumpy/settings.py rename to src/plumpy/settings.py diff --git a/plumpy/utils.py b/src/plumpy/utils.py similarity index 100% rename from plumpy/utils.py rename to src/plumpy/utils.py diff --git a/plumpy/workchains.py b/src/plumpy/workchains.py similarity index 100% rename from plumpy/workchains.py rename to src/plumpy/workchains.py