Skip to content

Commit 4953722

Browse files
committed
Add long description for a published PyPi package
1 parent de16741 commit 4953722

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

buildSrc/src/main/kotlin/distTasks.kt

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ fun ProjectWithOptions.prepareDistributionTasks() {
3434
dependsOn("installHintRemoverRequirements")
3535
}
3636
from(distributionPath)
37+
from("README.md")
3738
into(distribBuildPath)
3839
exclude(".idea/**")
3940

distrib/setup.py

+14
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
LIBRARIES_FOLDER_NAME = '.jupyter_kotlin'
1717
LIBRARIES_CACHE_FOLDER_NAME = 'cache'
1818
VERSION_FILE_NAME = 'VERSION'
19+
README_FILE_NAME = 'README.md'
1920

2021

2122
def main():
@@ -26,16 +27,29 @@ def main():
2627
abspath = path.abspath(__file__)
2728
current_dir = path.dirname(abspath)
2829
version_file = path.join(current_dir, VERSION_FILE_NAME)
30+
readme_file = path.join(current_dir, README_FILE_NAME)
2931

3032
with open(version_file, 'r') as f:
3133
version = f.read().strip()
3234

35+
with open(readme_file, 'r') as f:
36+
long_description = f.read()
37+
38+
classifiers = [
39+
"Framework :: Jupyter",
40+
"Development Status :: 4 - Beta",
41+
"Programming Language :: Kotlin",
42+
]
43+
3344
setup(name="kotlin-jupyter-kernel",
3445
author="JetBrains",
3546
version=version,
3647
url="https://github.com/Kotlin/kotlin-jupyter",
3748
license="Apache 2.0",
3849
description="Kotlin kernel for Jupyter notebooks",
50+
long_description=long_description,
51+
long_description_content_type="text/markdown",
52+
classifiers=classifiers,
3953
packages=find_packages(),
4054
package_data=PACKAGE_DATA,
4155
data_files=DATA_FILES

0 commit comments

Comments
 (0)