From c67702f5ba8d657a3959c8ad2ce4a58816edb9b1 Mon Sep 17 00:00:00 2001 From: Graham Ullrich Date: Sun, 5 Nov 2017 14:49:16 -0700 Subject: [PATCH] Add PyPi compatible long description update changelog --- README.md | 3 ++- setup.py | 61 +++++++++++++++++++++++++++++++++++++++++-------------- 2 files changed, 48 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 43eb38bb..7d89b47c 100644 --- a/README.md +++ b/README.md @@ -446,12 +446,13 @@ and which are not dismissed. _*BI*_ = backward incompatible change -### 4.1 +### 4.1.0 * Add Django 2.0 compatibility testing * Drop Django 1.9 and Python 3.3 support * Move documentation into README * Convert CI and coverage to CircleCi and CodeCov +* Add PyPi-compatible long description ### 4.0 * _*BI*_: To support changes to `render_to_string` in Django 1.10 and above, diff --git a/setup.py b/setup.py index b7080463..616d52c3 100644 --- a/setup.py +++ b/setup.py @@ -1,28 +1,59 @@ -import codecs - -from os import path from setuptools import find_packages, setup +LONG_DESCRIPTION = """ +.. image:: http://pinaxproject.com/pinax-design/patches/pinax-notifications.svg + :target: https://pypi.python.org/pypi/pinax-notifications/ + +=================== +Pinax Notifications +=================== + +.. image:: https://img.shields.io/pypi/v/pinax-notifications.svg + :target: https://pypi.python.org/pypi/pinax-notifications/ +.. image:: https://img.shields.io/badge/license-MIT-blue.svg + :target: https://pypi.python.org/pypi/pinax-notifications/ + +.. image:: https://img.shields.io/circleci/project/github/pinax/pinax-notifications.svg + :target: https://circleci.com/gh/pinax/pinax-notifications +.. image:: https://img.shields.io/codecov/c/github/pinax/pinax-notifications.svg + :target: https://codecov.io/gh/pinax/pinax-notifications +.. image:: https://img.shields.io/github/contributors/pinax/pinax-notifications.svg + :target: https://github.com/pinax/pinax-notifications/graphs/contributors +.. image:: https://img.shields.io/github/issues-pr/pinax/pinax-notifications.svg + :target: https://github.com/pinax/pinax-notifications/pulls +.. image:: https://img.shields.io/github/issues-pr-closed/pinax/pinax-notifications.svg + :target: https://github.com/pinax/pinax-notifications/pulls?q=is%3Apr+is%3Aclosed + +.. image:: http://slack.pinaxproject.com/badge.svg + :target: http://slack.pinaxproject.com/ + +``pinax-notifications`` is a user notification management app for the Django web framework. + +``pinax-notifications`` notifies users when certain events have occurred and allows +configurable options as to how those notifications are to be received. + +Features +-------- + +* Submission of notification messages by other apps +* Notification messages on signing in +* Notification messages via email (configurable by user) +* Ability to supply your own backend notification channels -def read(*parts): - filename = path.join(path.dirname(__file__), *parts) - with codecs.open(filename, encoding="utf-8") as fp: - return fp.read() +Supported Django and Python Versions +------------------------------------ -try: - from pypandoc import convert - read_md = lambda f: convert(f, "rst").replace("\r","") -except (ImportError, IOError): - print("warning: pypandoc module not found, could not convert Markdown to RST") - read_md = lambda f: read(f) +* Django 1.8, 1.10, 1.11, and 2.0 +* Python 2.7, 3.4, 3.5, and 3.6 +""" setup( author="Pinax Team", author_email="team@pinaxprojects.com", description="User notification management for the Django web framework", name="pinax-notifications", - long_description=read_md("README.md"), - version="4.1", + long_description=LONG_DESCRIPTION, + version="4.1.0", url="http://github.com/pinax/pinax-notifications/", license="MIT", packages=find_packages(),