Fix module imports and __init__ files - cookiecutter finally working :)

Felix Erdmann · Felix Erdmann · commit 3664b84462b7 · 2025-02-26T12:38:40.000+01:00
diff --git a/{{cookiecutter.project_name}}/README.rst b/{{cookiecutter.project_name}}/README.rst
@@ -19,8 +19,13 @@ Here write a short description of the plugin, indicating the importers, diagnost
 Installation instructions
 =========================
 
-Describe the installation instructions here. For example, how to install the plugin from
-the sources (cloning the repository and running `setup.py install`), or using `pip`.
+The pysteps plugin can be installed as a python package using ``pip`` from the local path *{{cookiecutter.project_slug}}/*.
+
+Install with
+
+.. code-block:: console
+
+   pip install {{cookiecutter.project_slug}}/
 
 Test the plugin
 ===============
diff --git a/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/__init__.py b/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/__init__.py
@@ -0,0 +1,3 @@
+from . import {{cookiecutter.plugin_type}}
+
+__all__ = ["{{cookiecutter.plugin_type}}"]
diff --git a/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/diagnostic/__init__.py b/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/diagnostic/__init__.py
@@ -1 +1,3 @@
-from {{cookiecutter.project_slug}}.diagnostic import {{cookiecutter.plugin_name}}
+from .{{cookiecutter.plugin_name}} import {{cookiecutter.plugin_function}}
+
+__all__ = ["{{cookiecutter.plugin_name}}"]
diff --git a/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/importer/__init__.py b/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/importer/__init__.py
@@ -1 +1,3 @@
-from {{cookiecutter.project_slug}}.importer import {{cookiecutter.plugin_name}}
+from .{{cookiecutter.plugin_name}} import {{cookiecutter.plugin_function}}
+
+__all__ = ["{{cookiecutter.plugin_name}}"]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from . import {{cookiecutter.plugin_type}}`
	`2`	`+`
	`3`	`+__all__ = ["{{cookiecutter.plugin_type}}"]`