Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR: Generate PyPI long description from README.md #101

Merged
merged 3 commits into from
Oct 24, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 4 additions & 25 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# -*- coding: utf-8 -*-
import os
import io
try:
from setuptools import setup
from setuptools.command.install import install
Expand All @@ -13,37 +14,15 @@
with open(os.path.join(here, 'qtawesome', '_version.py')) as f:
exec(f.read(), {}, version_ns)

LONG_DESCRIPTION = """
.. image:: https://img.shields.io/pypi/v/QtAwesome.svg
:target: https://pypi.python.org/pypi/QtAwesome/
:alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/QtAwesome.svg
:target: https://pypi.python.org/pypi/QtAwesome/
:alt: Number of PyPI downloads

QtAwesome - Iconic Fonts in PyQt and PySide applications
========================================================

QtAwesome enables iconic fonts such as Font Awesome and Elusive Icons in PyQt and PySide applications.

It is a port to Python - PyQt / PySide of the QtAwesome C++ library by Rick Blommers.

.. code-block:: python

# Get icons by name.
fa_icon = qta.icon('fa5s.flag')
fa_button = QtGui.QPushButton(fa_icon, 'Font Awesome!')

asl_icon = qta.icon('ei.asl')
elusive_button = QtGui.QPushButton(asl_icon, 'Elusive Icons!')
"""
with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
LONG_DESCRIPTION = f.read()

setup(
name='QtAwesome',
version=version_ns['__version__'],
description='FontAwesome icons in PyQt and PySide applications',
long_description=LONG_DESCRIPTION,
long_description_content_type='text/markdown',
author='Sylvain Corlay',
author_email='[email protected]',
license='MIT',
Expand Down