Skip to content

Commit 1bf4b73

Browse files
committed
add README
1 parent 1dc3637 commit 1bf4b73

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

stubs/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Metaflow Stubs
2+
3+
This package contains stub files for `metaflow` and thus offers type hints for various editors (such as `VSCode`) and language servers (such as `Pylance`).
4+
5+
## Installation
6+
7+
To install Metaflow Stubs in your local environment, you can install from [PyPi](https://pypi.org/project/metaflow/):
8+
9+
```sh
10+
pip install metaflow-stubs
11+
```

stubs/setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
name="metaflow-stubs",
99
version=version,
1010
description="Metaflow Stubs: Stubs for the metaflow package",
11-
long_description="Metaflow Stubs: Stubs for the metaflow package",
11+
long_description=open("README.md").read(),
1212
long_description_content_type="text/markdown",
1313
author="Metaflow Developers",
1414
author_email="[email protected]",

0 commit comments

Comments
 (0)