Skip to content

Commit

Permalink
Use Pypi's markdown descriptions (#289)
Browse files Browse the repository at this point in the history
  • Loading branch information
facelessuser authored Apr 30, 2018
1 parent b1f9cca commit eea53ec
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@
[![Requirements Status][requires-image]][requires-link]
[![pypi-version][pypi-image]][pypi-link]
![License][license-image-mit]

# PyMdown Extensions

Extensions for [Python Markdown](https://pythonhosted.org/Markdown/).

# Documentation

Extension documentation is found here: http://facelessuser.github.io/pymdown-extensions/.

# License

License is MIT except for a few exceptions. See [LICENSE](https://github.com/facelessuser/pymdown-extensions/blob/master/LICENSE.md) for more info.

[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/pymdown-extensions/master.svg
Expand Down
29 changes: 10 additions & 19 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,6 @@
import os
import imp

LONG_DESC = '''
PyMdown Extensions (pymdownx) is a collection of extensions for `Python Markdown`_.
It should work for Python Markdown versions 2.6.0 and greater.
You can check out the list of available extensions and learn more about them by `reading the docs`_.
.. _`Python Markdown`: https://pythonhosted.org/Markdown/
.. _`reading the docs`: http://facelessuser.github.io/pymdown-extensions/
Support
=======
Help and support is available here at the repositories `bug tracker`_.
Please read about `support and contributing`_ before creating issues.
.. _`bug tracker`: https://github.com/facelessuser/pymdown-extensions/issues
.. _`support and contributing`: http://facelessuser.github.io/pymdown-extensions/contributing/
'''


def get_version():
"""Get version and version_info without importing the entire module."""
Expand Down Expand Up @@ -54,6 +36,14 @@ def get_requirements(req):
return install_requires


def get_description():
"""Get long description."""

with open("README.md", 'r') as f:
desc = f.read()
return desc


VER, DEVSTATUS = get_version()


Expand All @@ -62,7 +52,8 @@ def get_requirements(req):
version=VER,
keywords='markdown extensions',
description='Extension pack for Python Markdown.',
long_description=LONG_DESC,
long_description=get_description(),
long_description_content_type='text/markdown',
author='Isaac Muse',
author_email='[email protected]',
url='https://github.com/facelessuser/pymdown-extensions',
Expand Down

0 comments on commit eea53ec

Please sign in to comment.