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 #319
openedx · Apr 11, 2023 · 15a9a9f · 15a9a9f
1 parent 53e1d1a
commit 15a9a9f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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
@@ -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='[email protected]',
     url='https://github.com/openedx/edx-drf-extensions',