From 72c04ee21cca9d5ae047ba0895ca4d434710c588 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Mon, 1 Apr 2024 14:18:50 -0400 Subject: [PATCH] docs: Add a long_description. The default empty long_description is failing when we try to push it to PyPI so make the README the long_description and be clear that it's markdown and not RST. We bump the version since we've already tagged the old version that failed to release. --- edxsearch/__init__.py | 2 +- setup.py | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/edxsearch/__init__.py b/edxsearch/__init__.py index c673376f..835caa16 100644 --- a/edxsearch/__init__.py +++ b/edxsearch/__init__.py @@ -1,3 +1,3 @@ """ Container module for testing / demoing search """ -__version__ = '3.9.0' +__version__ = '3.9.1' diff --git a/setup.py b/setup.py index b12433d0..9685ebea 100755 --- a/setup.py +++ b/setup.py @@ -2,6 +2,7 @@ """ Setup to allow pip installs of edx-search module """ import os import re +from pathlib import Path from setuptools import setup @@ -47,11 +48,16 @@ def get_version(*file_paths): VERSION = get_version('edxsearch', '__init__.py') +# read the contents of your README file +this_directory = Path(__file__).parent +long_description = (this_directory / "README.md").read_text() setup( name='edx-search', version=VERSION, description='Search and index routines for index access', + long_description=long_description, + long_description_content_type='text/markdown', author='edX', author_email='oscm@edx.org', url='https://github.com/openedx/edx-search',