From ad06fe60f89a80b8a4525b7eb59a77192119e6db Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Wed, 23 Sep 2020 21:04:56 +0200 Subject: [PATCH 1/4] Replace pypy page with README.md + CHANGES.md https://pypi.org/project/sentry-sdk/ is currently a bit too spartan and requires the user to do extra clicks to determine if they want to install or upgrade this package. This PR proposes to replace the current one-liner with the markdown content from `README.md` plus `CHANGES.md`. --- setup.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index c373e7aabf..4b64a39815 100644 --- a/setup.py +++ b/setup.py @@ -8,8 +8,17 @@ `_ to find out more. """ +import os from setuptools import setup, find_packages +here = os.path.abspath(os.path.dirname(__file__)) + + +def get_file_text(file_name): + with open(os.path.join(here, file_name)) as in_file: + return in_file.read() + + setup( name="sentry-sdk", version="0.17.8", @@ -17,7 +26,8 @@ author_email="hello@sentry.io", url="https://github.com/getsentry/sentry-python", description="Python client for Sentry (https://sentry.io)", - long_description=__doc__, + long_description="\n".join((get_file_text("README.md"), get_file_text("CHANGES.md"))) + long_description_content_type='text/markdown', packages=find_packages(exclude=("tests", "tests.*")), # PEP 561 package_data={"sentry_sdk": ["py.typed"]}, From ab23ed0bd014c0a7e6315ed117eff2dd2674c02d Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Wed, 23 Sep 2020 21:52:31 +0200 Subject: [PATCH 2/4] fixup! , --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 4b64a39815..1e9f9111d1 100644 --- a/setup.py +++ b/setup.py @@ -26,7 +26,7 @@ def get_file_text(file_name): author_email="hello@sentry.io", url="https://github.com/getsentry/sentry-python", description="Python client for Sentry (https://sentry.io)", - long_description="\n".join((get_file_text("README.md"), get_file_text("CHANGES.md"))) + long_description="\n".join((get_file_text("README.md"), get_file_text("CHANGES.md"))), long_description_content_type='text/markdown', packages=find_packages(exclude=("tests", "tests.*")), # PEP 561 From 32ce95a5fd52223f7ce09842f01ceb938ce6964e Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Wed, 23 Sep 2020 22:07:33 +0200 Subject: [PATCH 3/4] fixup! CHANGES.md is not available to setup.py --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 1e9f9111d1..dc5f92f473 100644 --- a/setup.py +++ b/setup.py @@ -26,7 +26,7 @@ def get_file_text(file_name): author_email="hello@sentry.io", url="https://github.com/getsentry/sentry-python", description="Python client for Sentry (https://sentry.io)", - long_description="\n".join((get_file_text("README.md"), get_file_text("CHANGES.md"))), + long_description=get_file_text("README.md"), long_description_content_type='text/markdown', packages=find_packages(exclude=("tests", "tests.*")), # PEP 561 From 55d05b2dbc34c081fa3dc2b1c9618d350e2c4b8b Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Mon, 2 Nov 2020 19:27:10 +0100 Subject: [PATCH 4/4] fix relative links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index add454fde2..559de37da3 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ raise ValueError() # Will also create an event. # Contributing to the SDK -Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md). +Please refer to [CONTRIBUTING.md](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md). # License -Licensed under the BSD license, see [`LICENSE`](./LICENSE) +Licensed under the BSD license, see [`LICENSE`](https://github.com/getsentry/sentry-python/blob/master/LICENSE)