From 1dc363780961bb1a72cf5900e5fc9a24d429a9a9 Mon Sep 17 00:00:00 2001 From: Madhur Tandon Date: Thu, 8 Feb 2024 17:57:18 +0530 Subject: [PATCH 1/2] fix missing long_description --- stubs/setup.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/stubs/setup.py b/stubs/setup.py index 894eb717cc1..bd938fae986 100644 --- a/stubs/setup.py +++ b/stubs/setup.py @@ -8,6 +8,8 @@ name="metaflow-stubs", version=version, description="Metaflow Stubs: Stubs for the metaflow package", + long_description="Metaflow Stubs: Stubs for the metaflow package", + long_description_content_type="text/markdown", author="Metaflow Developers", author_email="help@metaflow.org", license="Apache Software License", From 1bf4b73fa0cf284979c0dcd15f6fd7503f2c0b7f Mon Sep 17 00:00:00 2001 From: Madhur Tandon Date: Thu, 8 Feb 2024 18:56:41 +0530 Subject: [PATCH 2/2] add README --- stubs/README.md | 11 +++++++++++ stubs/setup.py | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 stubs/README.md diff --git a/stubs/README.md b/stubs/README.md new file mode 100644 index 00000000000..2c353d7818d --- /dev/null +++ b/stubs/README.md @@ -0,0 +1,11 @@ +# Metaflow Stubs + +This package contains stub files for `metaflow` and thus offers type hints for various editors (such as `VSCode`) and language servers (such as `Pylance`). + +## Installation + +To install Metaflow Stubs in your local environment, you can install from [PyPi](https://pypi.org/project/metaflow/): + +```sh +pip install metaflow-stubs +``` diff --git a/stubs/setup.py b/stubs/setup.py index bd938fae986..559837fef9b 100644 --- a/stubs/setup.py +++ b/stubs/setup.py @@ -8,7 +8,7 @@ name="metaflow-stubs", version=version, description="Metaflow Stubs: Stubs for the metaflow package", - long_description="Metaflow Stubs: Stubs for the metaflow package", + long_description=open("README.md").read(), long_description_content_type="text/markdown", author="Metaflow Developers", author_email="help@metaflow.org",