diff --git a/README.md b/README.md index e2275af..3d3e240 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Which will output: ```html
Hey look at my map! - +
``` @@ -77,3 +77,16 @@ above: width. This will make the iframe expand to full width of the page (or any other container you put it in) fluidly, whilst maintaining the same aspect ratio. Default is False. + +### Contributing +Pull requests are welcome, though we'd be grateful if you would +open an issue to discuss your feature/bugfix first. + +To install the development dependencies locally it's: +`$ pip install -e .[dev]` + +To run the tests it is just: +`$ python -m unittest ` + +You'll need to follow PEP8 in addition to the [Google Python Style Guide.](https://github.com/google/styleguide/blob/gh-pages/pyguide.md) +Sensible deviations from the above will be considered. diff --git a/mdx_google_map.py b/mdx_google_map.py index adfbfcc..c803881 100644 --- a/mdx_google_map.py +++ b/mdx_google_map.py @@ -36,7 +36,7 @@ def __init__(self, config_getter=os.environ.get, **kwargs): def extendMarkdown(self, md, md_globals): """ Extends markdown with inline patterns providing Google map function. - + See base class for further info. """ google_map = GoogleMapPattern(MAP_MATCH) diff --git a/setup.py b/setup.py index c2a02e2..9256de9 100644 --- a/setup.py +++ b/setup.py @@ -1,14 +1,17 @@ +from os import path from setuptools import setup -# To develop this markdown extension itself, you should install with -# pip install -e .[dev] to get dev dependencies + +this_directory = path.abspath(path.dirname(__file__)) +with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + + setup( name='mdx_google_map', description='A python Markdown extension providing Google Maps syntax', - long_description=( - 'A python Markdown extension providing Google Maps syntax. ' - 'For more details visit https://github.com/tictocs/markdown-google-map' - ), + long_description=long_description, + long_description_content_type='text/markdown', author='Tom Manterfield @ Tic Tocs Tech', author_email='tom@tictocs.com', url='https://github.com/tictocs/markdown-google-map/', @@ -18,7 +21,7 @@ 'License :: OSI Approved :: MIT License', 'Programming Language :: Python :: 3' ], - version='1.0.0', + version='1.0.1', py_modules=['mdx_google_map'], install_requires=['markdown>=2.6.11'], extras_require={