From 346b82e550947b99220e3790602df26e2f520dc4 Mon Sep 17 00:00:00 2001 From: Maroun Touma Date: Mon, 23 Sep 2024 15:19:11 +0200 Subject: [PATCH] Added readme file to test, build and publish package to pypi Signed-off-by: Maroun Touma --- transforms/packaging/README.md | 52 ++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 transforms/packaging/README.md diff --git a/transforms/packaging/README.md b/transforms/packaging/README.md new file mode 100644 index 000000000..1a1ffa5fd --- /dev/null +++ b/transforms/packaging/README.md @@ -0,0 +1,52 @@ +# Transforms Pacakges for both Python and Ray + +Most available Transforms can be published to pypi as a single package. A detailed list of available Python transforms is available at this (link)[python/README.md]. Similarly the following (link)[ray/README.md] provide a derailed list and installation instructions for Ray transforms + + + +## Clone folder and update version number + +git clone https://github.com/IBM/data-prep-kit.git release +cd release + +in `.make.versions`, Set the values for DPK_MAJOR_VERSION, DPK_MINOR_VERSION and DPK_MICRO_VERSION to specify the DPK library to use and as appropriate, set the value for `DPK_TRANSFORMS_VERSION` that will be used to tag the latest version released to pypi + + +## Creating src folder + +Given that the transforms do not currently have their own name spaces, the first step is to copy all the transforms to the same src folder prior to running unit tests of the individual transforms and/or building the distribution: + + +```` +cd release/transforms/packaging +make clean +make src +```` + +## Build and Test + +This procedure will run all the UT for each individual transforms using a single package configuration: + +```` +cd release/transforms/packaging +make clean +make src +make test-src +```` + +## Build and Deploy + +This procedure will buid and publish two wheels to pypi.org: one for the python transforms and one for the ray transforms. + +```` +cd release/transforms/packaging +make clean +make src +make set-version +make build-dist +make publish-dist +```` + + + +