Skip to content

Commit

Permalink
chore(sdk): add kfp-kubernetes documentation to PyPI (kubeflow#9148)
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-mccarthy authored and rd-pong committed Apr 26, 2023
1 parent 5f659d4 commit d2c06cc
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion kubernetes_platform/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The `kfp-kubernetes` Python library enables authoring [Kubeflow pipelines](https
* [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
* [PersistentVolumeClaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)

<!-- TODO: add reference to kubeflow user docs on support for platform-specific features once they exist -->
See the [`kfp-kubernetes` reference documentation](https://kfp-kubernetes.readthedocs.io/).

## Installation
The `kfp-kubernetes` package can be installed as a `kfp` SDK extra dependency with `kfp==2.x.x`:
Expand Down
16 changes: 16 additions & 0 deletions kubernetes_platform/python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,29 @@ def find_version(*file_path_parts: str) -> str:
raise ValueError('Could not find version.')


def read_readme() -> str:
readme_path = os.path.join(os.path.dirname(__file__), 'README.md')
with open(readme_path) as f:
return f.read()


setuptools.setup(
name=NAME,
version=find_version('kfp', 'kubernetes', '__init__.py'),
description='Kubernetes platform configuration library and generated protos.',
long_description=read_readme(),
long_description_content_type='text/markdown',
author='google',
author_email='[email protected]',
url='https://github.com/kubeflow/pipelines',
project_urls={
'Documentation':
'https://kfp-kubernetes.readthedocs.io/',
'Bug Tracker':
'https://github.com/kubeflow/pipelines/issues',
'Source':
'https://github.com/kubeflow/pipelines/tree/master/kubernetes_platform/python',
},
packages=setuptools.find_namespace_packages(include=['kfp.*']),
python_requires='>=3.7.0',
install_requires=REQUIREMENTS,
Expand Down

0 comments on commit d2c06cc

Please sign in to comment.