Skip to content

Commit

Permalink
Added readme file to test, build and publish package to pypi
Browse files Browse the repository at this point in the history
Signed-off-by: Maroun Touma <touma@us.ibm.com>
  • Loading branch information
touma-I committed Sep 23, 2024
1 parent ee63628 commit 346b82e
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions transforms/packaging/README.md
Original file line number Diff line number Diff line change
@@ -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
````




0 comments on commit 346b82e

Please sign in to comment.