From 15a9a9f47fb2b4187758be78513420701ebea34c Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Tue, 11 Apr 2023 11:40:05 -0400 Subject: [PATCH] fix: allow packaging to work (#322) Setup needed a ``long_description`` to all packaging to work, potentially due to a twine bug. This should fix the issue. See https://github.com/openedx/edx-drf-extensions/issues/319 --- CHANGELOG.rst | 8 ++++++++ MANIFEST.in | 1 + edx_rest_framework_extensions/__init__.py | 2 +- setup.py | 4 ++++ 4 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f40a2c73..886a4bfa 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -12,6 +12,14 @@ Change Log Unreleased ---------- +[8.5.1] - 2023-04-11 +-------------------- + +Fixed +~~~~~ + +* (Hopefully) fixed the ability to publish edx-drf-extensions, by adding a ``long_description`` to setup.py. + [8.5.0] - 2023-04-05 -------------------- diff --git a/MANIFEST.in b/MANIFEST.in index 3c1ac6e7..611a0482 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ include requirements/base.in include requirements/test.in include requirements/docs.in +include CHANGELOG.rst include LICENSE include README.rst test_settings.py diff --git a/edx_rest_framework_extensions/__init__.py b/edx_rest_framework_extensions/__init__.py index caa68a28..a3d7cd67 100644 --- a/edx_rest_framework_extensions/__init__.py +++ b/edx_rest_framework_extensions/__init__.py @@ -1,3 +1,3 @@ """ edx Django REST Framework extensions. """ -__version__ = '8.5.0' # pragma: no cover +__version__ = '8.5.1' # pragma: no cover diff --git a/setup.py b/setup.py index f5a17e53..5f69e357 100644 --- a/setup.py +++ b/setup.py @@ -88,11 +88,15 @@ def get_version(*file_paths): VERSION = get_version("edx_rest_framework_extensions", "__init__.py") +README = open(os.path.join(os.path.dirname(__file__), 'README.rst'), encoding="utf8").read() +CHANGELOG = open(os.path.join(os.path.dirname(__file__), 'CHANGELOG.rst'), encoding="utf8").read() + setup( name='edx-drf-extensions', version=VERSION, description='edX extensions of Django REST Framework', + long_description=README + '\n\n' + CHANGELOG, author='edX', author_email='oscm@edx.org', url='https://github.com/openedx/edx-drf-extensions',