Merge pull request #303 from openedx/feanil/fix_description

build: Add a long_descriptino which is now a required field.

.github/workflows/ci.yml

@@ -37,7 +37,8 @@ jobs:
 
     - name: Run Coverage
       if: matrix.python-version == '3.11' && matrix.toxenv=='django42'
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v4
       with:
         flags: unittests
         fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

opaque_keys/__init__.py

@@ -14,7 +14,7 @@
 from stevedore.enabled import EnabledExtensionManager
 from typing_extensions import Self  # For python 3.11 plus, can just use "from typing import Self"
 
-__version__ = '2.7.0'
+__version__ = '2.8.0'
 
 
 class InvalidKeyError(Exception):

setup.py

@@ -4,6 +4,7 @@
 """
 import os
 import re
+from pathlib import Path
 
 from setuptools import find_packages, setup
 
@@ -90,9 +91,15 @@ def get_version(*file_paths):
 
 VERSION = get_version("opaque_keys", "__init__.py")
 
+# read the contents of your README file
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.rst").read_text()
+
 
 setup(
     name='edx-opaque-keys',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
     version=VERSION,
     author='edX',
     url='https://github.com/openedx/opaque-keys',
@@ -105,8 +112,7 @@ def get_version(*file_paths):
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Framework :: Django",
-        "Framework :: Django :: 3.2",
-        "Framework :: Django :: 4.0",
+        "Framework :: Django :: 4.2",
     ],
     # We are including the tests because other libraries do use mixins from them.
     packages=find_packages(),