Skip to content

Commit 8635524

Browse files
authored
Merge pull request #159 from idling-mind/master
Fix: long_description missing in setup.py
2 parents d4742d0 + 9d420a7 commit 8635524

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

{{cookiecutter.project_shortname}}/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
{{cookiecutter.project_name}} is a Dash component library.
44

5+
{{cookiecutter.description}}
6+
57
Get started with:
68
1. Install Dash and its dependencies: https://dash.plotly.com/installation
79
2. Run `python usage.py`

{{cookiecutter.project_shortname}}/setup.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import json
2-
import os
32
from setuptools import setup
3+
from pathlib import Path
44

5-
5+
here = Path(__file__).parent
66
with open('package.json') as f:
77
package = json.load(f)
8+
long_description = (here / 'README.md').read_text()
89

910
package_name = package["name"].replace(" ", "_").replace("-", "_")
1011

@@ -16,6 +17,8 @@
1617
include_package_data=True,
1718
license=package['license'],
1819
description=package.get('description', package_name),
20+
long_description=long_description,
21+
long_description_content_type="text/markdown",
1922
install_requires=[],
2023
classifiers = [
2124
'Framework :: Dash',

0 commit comments

Comments
 (0)