From 0324d6bf18188db38d855a1b8450b596bebf0360 Mon Sep 17 00:00:00 2001 From: Laurent LAPORTE Date: Sat, 6 Oct 2018 15:21:30 +0200 Subject: [PATCH] Populate the project `long_description` by reading the `README.rst` file using "utf-8" encoding and excluding potential Sphinx directives. --- {{cookiecutter.package_name}}/setup.py | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.package_name}}/setup.py b/{{cookiecutter.package_name}}/setup.py index e7e9939..afd0bb5 100644 --- a/{{cookiecutter.package_name}}/setup.py +++ b/{{cookiecutter.package_name}}/setup.py @@ -1,6 +1,19 @@ -import setuptools +import io +import os +import re -setuptools.setup( +from setuptools import find_packages +from setuptools import setup + + +def read(filename): + filename = os.path.join(os.path.dirname(__file__), filename) + text_type = type(u"") + with io.open(filename, mode="r", encoding='utf-8') as fd: + return re.sub(text_type(r':[a-z]+:`~?(.*?)`'), text_type(r'``\1``'), fd.read()) + + +setup( name="{{ cookiecutter.package_name }}", version="{{ cookiecutter.package_version }}", url="{{ cookiecutter.package_url }}", @@ -9,9 +22,9 @@ setuptools.setup( author_email="{{ cookiecutter.author_email }}", description="{{ cookiecutter.package_description }}", - long_description=open('README.rst').read(), + long_description=read("README.rst"), - packages=setuptools.find_packages(exclude=('tests',)), + packages=find_packages(exclude=('tests',)), install_requires=[],