From 24619dda805e0b971abf342315a007af80addc5a Mon Sep 17 00:00:00 2001 From: Marc Abramowitz Date: Fri, 30 Jan 2015 13:20:00 -0800 Subject: [PATCH] Support formats other than Markdown --- samples/basic/README.md | 11 ++++++++++- samples/basic/setup.py | 2 +- samples/rst/README.rst | 12 ++++++++++++ samples/rst/setup.py | 10 ++++++++++ setup.py | 4 +++- setuptools_markdown.py | 17 +++++++++++------ 6 files changed, 47 insertions(+), 9 deletions(-) create mode 100644 samples/rst/README.rst create mode 100755 samples/rst/setup.py diff --git a/samples/basic/README.md b/samples/basic/README.md index ebeeabb..d327bb4 100644 --- a/samples/basic/README.md +++ b/samples/basic/README.md @@ -1,3 +1,12 @@ -# setuptools-markdown_sample +setuptools-markdown\_sample +=========================== This is a **sample** project + +Here's some python: + +```python +def func(a, b): + c = a + b + return c +``` diff --git a/samples/basic/setup.py b/samples/basic/setup.py index 775b9f8..1a26945 100755 --- a/samples/basic/setup.py +++ b/samples/basic/setup.py @@ -6,5 +6,5 @@ setup( name='setuptools-markdown_sample', setup_requires=['setuptools-markdown'], - long_description_markdown_filename='README.md', + long_description_filename='README.md', ) diff --git a/samples/rst/README.rst b/samples/rst/README.rst new file mode 100644 index 0000000..3505138 --- /dev/null +++ b/samples/rst/README.rst @@ -0,0 +1,12 @@ +setuptools-markdown\_sample +=========================== + +This is a **sample** project + +Here's some python: + +.. code-block:: python + + def func(a, b): + c = a + b + return c diff --git a/samples/rst/setup.py b/samples/rst/setup.py new file mode 100755 index 0000000..0c30de7 --- /dev/null +++ b/samples/rst/setup.py @@ -0,0 +1,10 @@ +#!/usr/bin/env python +# setup.py + +from setuptools import setup + +setup( + name='setuptools-markdown_sample', + setup_requires=['setuptools-markdown'], + long_description_filename='README.rst', +) diff --git a/setup.py b/setup.py index 62993da..d25144e 100644 --- a/setup.py +++ b/setup.py @@ -21,6 +21,8 @@ zip_safe=False, entry_points=""" [distutils.setup_keywords] - long_description_markdown_filename=setuptools_markdown:long_description_markdown_filename + long_description_filename=setuptools_markdown:long_description_filename + long_description_markdown_filename=setuptools_markdown:long_description_filename + long_description_rst_filename=setuptools_markdown:long_description_filename """ ) diff --git a/setuptools_markdown.py b/setuptools_markdown.py index 24ab85a..b777625 100644 --- a/setuptools_markdown.py +++ b/setuptools_markdown.py @@ -9,17 +9,22 @@ logger = logging.getLogger(__name__) -def long_description_markdown_filename(dist, attr, value): +def long_description_filename(dist, attr, value): logger.debug( - 'long_description_markdown_filename: ' + 'long_description_filename: ' 'dist = %r; attr = %r; value = %r', dist, attr, value) + filename = _get_filepath(value) + output = pypandoc.convert(filename, 'rst') + dist.metadata.long_description = output + + +def _get_filepath(filename): frame = _get_code_object() setup_py_path = inspect.getsourcefile(frame) - markdown_filename = os.path.join(os.path.dirname(setup_py_path), value) - logger.debug('markdown_filename = %r', markdown_filename) - output = pypandoc.convert(markdown_filename, 'rst') - dist.metadata.long_description = output + filepath = os.path.join(os.path.dirname(setup_py_path), filename) + logger.debug('filepath = %r', filepath) + return filepath def _get_code_object():