mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-08-02 11:30:12 +03:00
Render markdown readme on PyPI
PyPI now supports GitHub-flavored Markdown descriptions (https://blog.thea.codes/github-flavored-markdown-on-pypi/), so there's no need to convert the README to rst with pypandoc any more.
This commit is contained in:
parent
fe54575e6a
commit
136850f26d
|
@ -7,8 +7,5 @@ twine==1.9.1
|
|||
# Transifex client for managing translation resources.
|
||||
transifex-client==0.11
|
||||
|
||||
# Pandoc to have a nice pypi page
|
||||
pypandoc
|
||||
|
||||
# readme_renderer to check readme syntax
|
||||
readme_renderer
|
||||
|
|
18
setup.py
18
setup.py
|
@ -8,16 +8,9 @@ from io import open
|
|||
|
||||
from setuptools import find_packages, setup
|
||||
|
||||
try:
|
||||
from pypandoc import convert_file
|
||||
|
||||
def read_md(f):
|
||||
return convert_file(f, 'rst')
|
||||
except ImportError:
|
||||
print("warning: pypandoc module not found, could not convert Markdown to RST")
|
||||
|
||||
def read_md(f):
|
||||
return open(f, 'r', encoding='utf-8').read()
|
||||
def read(f):
|
||||
return open(f, 'r', encoding='utf-8').read()
|
||||
|
||||
|
||||
def get_version(package):
|
||||
|
@ -32,10 +25,6 @@ version = get_version('rest_framework')
|
|||
|
||||
|
||||
if sys.argv[-1] == 'publish':
|
||||
try:
|
||||
import pypandoc
|
||||
except ImportError:
|
||||
print("pypandoc not installed.\nUse `pip install pypandoc`.\nExiting.")
|
||||
if os.system("pip freeze | grep twine"):
|
||||
print("twine not installed.\nUse `pip install twine`.\nExiting.")
|
||||
sys.exit()
|
||||
|
@ -56,7 +45,8 @@ setup(
|
|||
url='http://www.django-rest-framework.org',
|
||||
license='BSD',
|
||||
description='Web APIs for Django, made easy.',
|
||||
long_description=read_md('README.md'),
|
||||
long_description=read('README.md'),
|
||||
long_description_content_type='text/markdown',
|
||||
author='Tom Christie',
|
||||
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
|
||||
packages=find_packages(exclude=['tests*']),
|
||||
|
|
Loading…
Reference in New Issue
Block a user