Skip to content

Commit

Permalink
Clarify the <micropkg_name> argument to kedro micropkg package (#2835)
Browse files Browse the repository at this point in the history
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
  • Loading branch information
3 people authored Aug 2, 2023
1 parent 1e43163 commit 73a35bb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/nodes_and_pipelines/micro_packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ Micro-packaging allows users to share Kedro micro-packages across codebases, org

## Package a micro-package

You can package a micro-package by executing: `kedro micropkg package <micropkg_name>`
You can package a micro-package by executing: `kedro micropkg package <micropkg_name>`.

`<micropkg_name>` should be a Python module path like what would be used in an `import` statement, for example

`kedro micropkg package pipelines.data_processing`

* This will generate a new [source distribution](https://docs.python.org/3/distutils/sourcedist.html) for this micro-package.
* By default, the tar file will be saved into `dist/` directory inside your project.
Expand Down

0 comments on commit 73a35bb

Please sign in to comment.