From 31730f8bd51888bb460e3a151df504eb0e9cdea0 Mon Sep 17 00:00:00 2001 From: "Dominguez Ruiz, Javier (SanTech)" Date: Fri, 24 Apr 2020 12:04:26 +0100 Subject: [PATCH] changes to create documentation in pypi --- README.md | 2 +- setup.cfg | 2 +- setup.py | 13 ++++++++++--- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9c96b3d..3b33fa8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ [![GitHub release](https://img.shields.io/github/release/Santandersecurityresearch/DrHeader.svg)](https://GitHub.com/Santandersecurityresearch/DrHeader/releases/) -[![GitHub commits](https://img.shields.io/github/commits-since/Santandersecurityresearch/DrHeader/v1.2.0.svg)](https://GitHub.com/Santandersecurityresearch/DrHeader/commit/) +[![GitHub commits](https://img.shields.io/github/commits-since/Santandersecurityresearch/DrHeader/v1.2.1.svg)](https://GitHub.com/Santandersecurityresearch/DrHeader/commit/) [![Github all releases](https://img.shields.io/github/downloads/Santandersecurityresearch/DrHeader/total.svg)](https://GitHub.com/Santandersecurityresearch/DrHeader/releases/) [![HitCount](http://hits.dwyl.io/Santandersecurityresearch/DrHeader.svg)](http://hits.dwyl.io/Santandersecurityresearch/DrHeader) [![Total alerts](https://img.shields.io/lgtm/alerts/g/Santandersecurityresearch/DrHeader.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Santandersecurityresearch/DrHeader/alerts/) diff --git a/setup.cfg b/setup.cfg index 1cc290e..b29f1b8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.2.0 +current_version = 1.2.1 commit = True tag = True diff --git a/setup.py b/setup.py index 4c4e24a..166e6bf 100644 --- a/setup.py +++ b/setup.py @@ -5,8 +5,13 @@ from setuptools import setup -with open('README.md') as readme_file: - readme = readme_file.read() +import os + +base_dir = os.path.dirname(__file__) + + +with open(os.path.join(base_dir, "README.md")) as f: + long_description = f.read() with open('HISTORY.md') as history_file: history = history_file.read() @@ -39,7 +44,9 @@ ], }, install_requires=requirements, + description="DrHEADer helps with the audit of security headers received in response to a single request or a list of requests.", + long_description=long_description, include_package_data=True, keywords='drheader', author='Santander UK Security Engineering', @@ -49,6 +56,6 @@ test_suite='tests', tests_require=test_requirements, url='https://github.com/santandersecurityresearch/drheader', - version='1.2.0', + version='1.2.1', zip_safe=False, )