Skip to content

Commit

Permalink
Add PyPi compatible long description
Browse files Browse the repository at this point in the history
Update changelog
  • Loading branch information
grahamu committed Nov 5, 2017
1 parent f81e7d6 commit 6afb271
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 16 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,12 +289,13 @@ See `setup.py` for specific required versions of these packages.

## Change Log

### 6.1
### 6.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

### 6.0.3

Expand Down
63 changes: 48 additions & 15 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,28 +1,61 @@
import codecs

from os import path
from setuptools import find_packages, setup

LONG_DESCRIPTION = """
.. image:: http://pinaxproject.com/pinax-design/patches/pinax-blog.svg
:target: https://pypi.python.org/pypi/pinax-blog/
==========
Pinax Blog
==========
.. image:: https://img.shields.io/pypi/v/pinax-blog.svg
:target: https://pypi.python.org/pypi/pinax-blog/
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://pypi.python.org/pypi/pinax-blog/
.. image:: https://img.shields.io/circleci/project/github/pinax/pinax-blog.svg
:target: https://circleci.com/gh/pinax/pinax-blog
.. image:: https://img.shields.io/codecov/c/github/pinax/pinax-blog.svg
:target: https://codecov.io/gh/pinax/pinax-blog
.. image:: https://img.shields.io/github/contributors/pinax/pinax-blog.svg
:target: https://github.com/pinax/pinax-blog/graphs/contributors
.. image:: https://img.shields.io/github/issues-pr/pinax/pinax-blog.svg
:target: https://github.com/pinax/pinax-blog/pulls
.. image:: https://img.shields.io/github/issues-pr-closed/pinax/pinax-blog.svg
:target: https://github.com/pinax/pinax-blog/pulls?q=is%3Apr+is%3Aclosed
.. image:: http://slack.pinaxproject.com/badge.svg
:target: http://slack.pinaxproject.com/
``pinax-blog`` is a blog app for Django.
Features
--------
* support for multiple channels (e.g. technical vs business)
* use of Creole (optional) and Markdown as markup format
* Atom and RSS feeds
* previewing of blog posts before publishing
* optional ability to announce new posts on twitter
* Traditional date based urls or simpler slug-only urls, via configuration
* Control over opengraph and twitter card meta data per post
* Review comments per post for multi-author workflows
* public but secret urls for unpublished blog posts for easier review
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="[email protected]",
description="Blogging app for the Django web framework",
name="pinax-blog",
long_description=read_md("README.md"),
version="6.1",
long_description=LONG_DESCRIPTION,
version="6.1.0",
url="http://github.com/pinax/pinax-blog/",
license="MIT",
packages=find_packages(),
Expand Down

0 comments on commit 6afb271

Please sign in to comment.