From b3daad9e6a302f2fe7f1102c05e9b02e7cf53609 Mon Sep 17 00:00:00 2001 From: Thiago Crepaldi Date: Wed, 7 Mar 2018 15:57:47 -0800 Subject: [PATCH] Add 'long_description' for wheel package's metadata file --- bindings/python/setup.py | 8 ++++++++ bindings/python/setup_py_long_description.md | 5 +++++ 2 files changed, 13 insertions(+) create mode 100644 bindings/python/setup_py_long_description.md diff --git a/bindings/python/setup.py b/bindings/python/setup.py index 15d6b4328..ad63454ae 100644 --- a/bindings/python/setup.py +++ b/bindings/python/setup.py @@ -12,6 +12,13 @@ IS_WINDOWS = platform.system() == 'Windows' IS_PY2 = sys.version_info.major == 2 +# Utility function to read the specified file, located in the current directory, into memory +# It is useful to separate markdown texts from distutils/setuptools source code +def read_file(fname): + with open(os.path.join(os.path.dirname(__file__), fname)) as f: + content = f.read() + return content + # TODO should handle swig path specified via build_ext --swig-path if os.system('swig -version 1>%s 2>%s' % (os.devnull, os.devnull)) != 0: print("Please install swig (>= 3.0.10) and include it in your path.\n") @@ -260,6 +267,7 @@ setup(name=project_name, version=os.environ['CNTK_VERSION'], url="http://cntk.ai", description = 'CNTK is an open-source, commercial-grade deep learning framework.', + long_description = read_file('setup_py_long_description.md'), author = 'Microsoft Corporation', author_email = 'ai-opensource@microsoft.com', license='MIT', diff --git a/bindings/python/setup_py_long_description.md b/bindings/python/setup_py_long_description.md new file mode 100644 index 000000000..b4d5f739a --- /dev/null +++ b/bindings/python/setup_py_long_description.md @@ -0,0 +1,5 @@ +# The Microsoft Cognitive Toolkit + +A free, easy-to-use, open-source, commercial-grade toolkit that trains deep learning algorithms to learn like the human brain. + +Visit **http://cntk.ai** and get started ! \ No newline at end of file