Skip to content

Commit 1932179

Browse files
committed
chore: Switch package long description to markdown
Signed-off-by: Kai Blin <kblin@biosustain.dtu.dk>
1 parent 3c94dbf commit 1932179

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

publish.sh

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
#!/bin/bash
22
set -euo pipefail
33

4-
PANDOC=pandoc
5-
6-
${PANDOC} -f markdown_github -t rst -o README.rst README.md
74
rm -rf dist
85
python setup.py sdist bdist_wheel
96
twine upload dist/*
10-
rm README.rst

setup.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
from setuptools import setup
44
from setuptools.command.test import test as TestCommand
55

6+
7+
def read(fname):
8+
return open(os.path.join(os.path.dirname(__file__), fname)).read()
9+
10+
611
short_description = "Standalone application server framework using asyncio"
7-
long_description = short_description
8-
if os.path.exists('README.rst'):
9-
long_description = open('README.rst').read()
12+
long_description = read('README.md')
1013

1114
install_requires: list[str] = []
1215

@@ -44,6 +47,7 @@ def run_tests(self):
4447
author_email='kblin@biosustain.dtu.dk',
4548
description=short_description,
4649
long_description=long_description,
50+
long_description_content_type='text/markdown',
4751
install_requires=install_requires,
4852
tests_require=tests_require,
4953
cmdclass={'test': PyTest},

0 commit comments

Comments
 (0)