Stop producing .egg files from kedro package

Fix gh-2273. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
kedro-org · May 8, 2023 · db9a03b · db9a03b
1 parent 6531457
commit db9a03b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 45 deletions.
diff --git a/docs/source/deployment/single_machine.md b/docs/source/deployment/single_machine.md
@@ -45,24 +45,18 @@ If you prefer not to use containerisation, you can instead package your Kedro pr
 kedro package
 ```
 
-Kedro builds the package into the `dist/` folder of your project, and creates one `.egg` file and one `.whl` file, which are [Python packaging formats for binary distribution](https://packaging.python.org/overview/).
+Kedro builds the package into the `dist/` folder of your project, and creates a `.whl` file, which is [a Python packaging format for binary distribution](https://packaging.python.org/overview/).
 
-The resulting `.egg` and `.whl` packages only contain the Python source code of your Kedro pipeline, not any of the `conf/` and `data/` subfolders nor the `pyproject.toml` file.
+The resulting `.whl` package only contains the Python source code of your Kedro pipeline, not any of the `conf/` and `data/` subfolders nor the `pyproject.toml` file.
 The project configuration is packaged separately in a `tar.gz` file. This compressed version of the config files excludes any files inside your `local` directory.
 This means that you can distribute the project to run elsewhere, such as on a separate computer with different configuration, data and logging. When distributed, the packaged project must be run from within a directory that contains the `pyproject.toml` file and `conf/` subfolder (and `data/` if your pipeline loads/saves local data). This means that you will have to create these directories on the remote servers manually.
 
-Recipients of the `.egg` and `.whl` files need to have Python and `pip` set up on their machines, but do not need to have Kedro installed. The project is installed to the root of a folder with the relevant `conf/` and `data/` subfolders, by navigating to the root and calling:
+Recipients of the `.whl` file need to have Python and `pip` set up on their machines, but do not need to have Kedro installed. The project is installed to the root of a folder with the relevant `conf/` and `data/` subfolders, by navigating to the root and calling:
 
 ```console
 pip install <path-to-wheel-file>
 ```
 
-Or when using the .egg file:
-
-```console
-easy_install <path-to-egg-file>
-```
-
 After having installed your project on the remote server, run the Kedro project as follows from the root of the project:
 
 ```console

diff --git a/docs/source/development/commands_reference.md b/docs/source/development/commands_reference.md
@@ -357,7 +357,7 @@ A parameterised run is best used for dynamic parameters, i.e. running the same p
 
 ### Deploy the project
 
-The following packages your application as one `.egg` file  and one `.whl` file within the `dist/` folder of your project. It packages the project configuration separately in a `tar.gz` file:
+The following packages your application as one `.whl` file within the `dist/` folder of your project. It packages the project configuration separately in a `tar.gz` file:
 
 ```bash
 kedro package

diff --git a/kedro/framework/cli/project.py b/kedro/framework/cli/project.py
@@ -148,28 +148,15 @@ def ipython(
 @project_group.command()
 @click.pass_obj  # this will pass the metadata as first argument
 def package(metadata: ProjectMetadata):
-    """Package the project as a Python egg and wheel."""
+    """Package the project as a Python wheel."""
     source_path = metadata.source_dir
     call(
         [
             sys.executable,
-            "setup.py",
-            "clean",
-            "--all",
-            "bdist_egg",
-            "--dist-dir",
-            "../dist",
-        ],
-        cwd=str(source_path),
-    )
-    call(
-        [
-            sys.executable,
-            "setup.py",
-            "clean",
-            "--all",
-            "bdist_wheel",
-            "--dist-dir",
+            "-m",
+            "build",
+            "--wheel",
+            "--outdir",
             "../dist",
         ],
         cwd=str(source_path),

diff --git a/tests/framework/cli/test_project.py b/tests/framework/cli/test_project.py
@@ -296,23 +296,10 @@ def test_happy_path(
                 mocker.call(
                     [
                         sys.executable,
-                        "setup.py",
-                        "clean",
-                        "--all",
-                        "bdist_egg",
-                        "--dist-dir",
-                        "../dist",
-                    ],
-                    cwd=str(fake_repo_path / "src"),
-                ),
-                mocker.call(
-                    [
-                        sys.executable,
-                        "setup.py",
-                        "clean",
-                        "--all",
-                        "bdist_wheel",
-                        "--dist-dir",
+                        "-m",
+                        "build",
+                        "--wheel",
+                        "--outdir",
                         "../dist",
                     ],
                     cwd=str(fake_repo_path / "src"),