Merge pull request #411 from johnthagen/add-long-description

Include long description in package metadata

Author: johnthagen

docs/changelog.rst

@@ -13,7 +13,7 @@ Unreleased
 * Fix authentication error when postgres is password protected `#361`_
 * Use exclude-table-data instead of exclude-table `#363`_
 * Add support for exclude tables data in the command interface `#375`_
-* Documentation fixes `#341`_ `#333`_ `#349`_ `#348`_ `#337`_
+* Documentation fixes `#341`_ `#333`_ `#349`_ `#348`_ `#337`_ `#411`_
 
 
 3.3.0 (2020-04-14)
@@ -58,3 +58,4 @@ Unreleased
 .. _`#408`: https://github.com/django-dbbackup/django-dbbackup/pull/408
 .. _`#371`: https://github.com/django-dbbackup/django-dbbackup/pull/371
 .. _`#379`: https://github.com/django-dbbackup/django-dbbackup/pull/379
+.. _`#411`: https://github.com/django-dbbackup/django-dbbackup/pull/411

setup.py

@@ -1,4 +1,7 @@
 #!/usr/bin/env python
+
+from pathlib import Path
+
 from setuptools import setup, find_packages
 import dbbackup
 
@@ -11,6 +14,9 @@ def get_test_requirements():
     return open('requirements-tests.txt').read().splitlines()
 
 
+project_dir = Path(__file__).parent
+
+
 keywords = [
     'django', 'database', 'media', 'backup',
     'amazon', 's3' 'dropbox',
@@ -22,6 +28,7 @@ def get_test_requirements():
     description=dbbackup.__doc__,
     author=dbbackup.__author__,
     author_email=dbbackup.__email__,
+    long_description=project_dir.joinpath("README.rst").read_text(encoding="utf-8"),
     python_requires=">=3.6",
     install_requires=get_requirements(),
     tests_require=get_test_requirements(),