Skip to content

Commit

Permalink
add long description to setup.py (#134)
Browse files Browse the repository at this point in the history
This description is sourced from README.md.
All the lines starting with '[![' are removed. These are used for
displaying badges on GitHub, but do not have guaranty to work
elsewhere. For examples these badges are displayed incorrectly in
pypi.org.
  • Loading branch information
zmiklank committed Apr 5, 2023
1 parent ae8475a commit b85dc97
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,16 @@ def get_requirements():
with open('requirements.txt') as f:
return f.read().splitlines()

def get_long_description():
with open('README.md') as f:
return str([l for l in f.read().splitlines() if not l.startswith('[![')])

setup(
name='distgen',
version=dg_version,
description='Templating system/generator for distributions',
long_description=get_long_description(),
long_description_content_type='text/markdown',
author='Pavel Raiskup (see AUTHORS)',
author_email='praiskup@redhat.com',
maintainer='Bohuslav Kabrda',
Expand Down

0 comments on commit b85dc97

Please sign in to comment.