Skip to content

Commit

Permalink
build: Add a long_descriptino which is now a required field.
Browse files Browse the repository at this point in the history
Previously it could be empty but now PyPI throws an error when you try
to publish with an empty long description.

Fix that, and bump the version.  We're also updating the django
classifiers to be more accurate.
  • Loading branch information
feanil committed Apr 20, 2024
1 parent d2a3ae6 commit ae66240
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion opaque_keys/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
10 changes: 8 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"""
import os
import re
from pathlib import Path

from setuptools import find_packages, setup

Expand Down Expand Up @@ -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',
Expand All @@ -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(),
Expand Down

0 comments on commit ae66240

Please sign in to comment.