From d2c06ccb896c1096555453e4ab0e36f6a5be5652 Mon Sep 17 00:00:00 2001 From: Connor McCarthy Date: Thu, 13 Apr 2023 13:47:43 -0700 Subject: [PATCH] chore(sdk): add kfp-kubernetes documentation to PyPI (#9148) --- kubernetes_platform/python/README.md | 2 +- kubernetes_platform/python/setup.py | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/kubernetes_platform/python/README.md b/kubernetes_platform/python/README.md index 4a351ff46573..fbce1f56a6c2 100644 --- a/kubernetes_platform/python/README.md +++ b/kubernetes_platform/python/README.md @@ -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) - +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`: diff --git a/kubernetes_platform/python/setup.py b/kubernetes_platform/python/setup.py index 1db62352de69..12f5fcbb487b 100644 --- a/kubernetes_platform/python/setup.py +++ b/kubernetes_platform/python/setup.py @@ -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='kubeflow-pipelines@google.com', 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,