Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the <micropkg_name> argument to kedro micropkg package #2835

Merged
merged 5 commits into from
Aug 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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