add custom setup.py to install mpijob module

[vsoch]

Problem: we cannot currently install the python mpijob module Solution: add a setup.py proper that is ignored by the generator

Notes:

• I chose kubeflow-mpijob to reflect the name of the Python module (typical practice, with a prefix)
• Tested with pip install .
• I didn't test with the generator yet, but saw this pattern to add the file to be ignored that (hopefully) will work.

Future improvements:

• more documentation about install
• full examples directory
• release package to pypi

This will close #578

[google-oss-prow[bot]]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: terrytangyuan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubeflow/mpi-operator/blob/master/OWNERS)~~ [terrytangyuan] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

[cliu-nuro]

Hi @vsoch , what's the timeline like to release this package to pypi?

[vsoch]

hey @cliu-nuro - there is no timeline, it's more that we could do it when it's requested. It isn't super hard, a maintainer/owner would need to create the first (dummy) deployment locally, usually you just do:

python setup.py sdist
twine upload dist/<path-to-tar-gz>

or create the package manually in the UI. Then get a pypi token / username for the package, explicitly, and then you just need a workflow like this:

name: release mpijob

on:
  release:
    types: [created]

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Install
      run: conda create --quiet --name mpijob twine

    - name: Install dependencies
      run: |
        export PATH="/usr/share/miniconda/bin:$PATH"
        source activate mpijob
        cd /path/to/where/mpijob/setup.py/is
        pip install -e .[all]
        pip install setuptools wheel twine
    - name: Build and publish
      env:
        TWINE_USERNAME: ${{ secrets.PYPI_USER }}
        TWINE_PASSWORD: ${{ secrets.PYPI_PASS }}
      run: |
        export PATH="/usr/share/miniconda/bin:$PATH"
        source activate mpijob
        python setup.py sdist bdist_wheel
        twine upload dist/*

And that should upload on releases. I'm not a maintainer here so I can't do most of that, but happy to provide guidance!

[alculquicondor]

@terrytangyuan what was the process to release to pypi?

[terrytangyuan]

I don't think we have a process yet. It's not published to PyPI.

[terrytangyuan]

We can instruct users to install directly from GitHub.