encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-02 19:40:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Render markdown readme on PyPI

Browse Source 
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:
Steven Loria 2018-05-26 09:38:02 -04:00
parent fe54575e6a
commit 136850f26d
No known key found for this signature in database
GPG Key ID: 631262B829DDB506
2 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
requirements/requirements-packaging.txt
View File

@ -7,8 +7,5 @@ twine==1.9.1
# Transifex client for managing translation resources. # Transifex client for managing translation resources.
transifex-client==0.11 transifex-client==0.11
# Pandoc to have a nice pypi page
pypandoc
# readme_renderer to check readme syntax # readme_renderer to check readme syntax
readme_renderer readme_renderer

18
setup.py
View File

@ -8,16 +8,9 @@ from io import open
from setuptools import find_packages, setup from setuptools import find_packages, setup
try:
from pypandoc import convert_file
def read_md(f): def read(f):
return convert_file(f, 'rst') return open(f, 'r', encoding='utf-8').read()
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 get_version(package): def get_version(package):
@ -32,10 +25,6 @@ version = get_version('rest_framework')
if sys.argv[-1] == 'publish': 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"): if os.system("pip freeze | grep twine"):
print("twine not installed.\nUse `pip install twine`.\nExiting.") print("twine not installed.\nUse `pip install twine`.\nExiting.")
sys.exit() sys.exit()
@ -56,7 +45,8 @@ setup(
url='http://www.django-rest-framework.org', url='http://www.django-rest-framework.org',
license='BSD', license='BSD',
description='Web APIs for Django, made easy.', 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='Tom Christie',
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*) author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
packages=find_packages(exclude=['tests*']), packages=find_packages(exclude=['tests*']),