From db5c3c2e2981852b7aecbe0ccc47233c6cf52faa Mon Sep 17 00:00:00 2001 From: Felipe Zipitria Date: Thu, 25 Mar 2021 10:22:43 -0300 Subject: [PATCH] docs: enhance pypi documentation Signed-off-by: Felipe Zipitria --- pyproject.toml | 6 +++++ setup.py | 67 ++++++++++++++++++++++++++++++-------------------- 2 files changed, 47 insertions(+), 26 deletions(-) create mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..374b58c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/setup.py b/setup.py index 006a82b..3167678 100644 --- a/setup.py +++ b/setup.py @@ -1,29 +1,44 @@ -#!/usr/bin/env python +import setuptools -from setuptools import setup +with open("README.md", "r", encoding="utf-8") as fh: + long_description = fh.read() -setup(name='ftw', - description='Framework for Testing WAFs', - author='Chaim Sanders, Zack Allen', - author_email='zma4580@gmail.com, chaim.sanders@gmail.com', - url='https://www.github.com/coreruleset/ftw', - include_package_data=True, - package_data={ +setuptools.setup( + name='ftw', + description='Framework for Testing WAFs', + long_description=long_description, + long_description_content_type="text/markdown", + author='Chaim Sanders, Zack Allen', + author_email='zma4580@gmail.com, chaim.sanders@gmail.com', + url='https://github.com/coreruleset/ftw', + include_package_data=True, + package_data={ 'ftw': ['util/public_suffix_list.dat'] - }, - entry_points={ - 'pytest11': [ - 'ftw = ftw.pytest_plugin' - ] - }, - packages=['ftw'], - keywords=['waf'], - use_scm_version=True, - setup_requires=['setuptools_scm'], - install_requires=[ - 'Brotli==1.0.7', - 'IPy==0.83', - 'PyYAML==4.2b1', - 'pytest==4.6', - 'python-dateutil==2.6.0' - ]) + }, + entry_points={ + 'pytest11': [ + 'ftw = ftw.pytest_plugin' + ] + }, + keywords=['waf'], + project_urls={ + "Bug Tracker": 'https://github.com/coreruleset/ftw/issues', + }, + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", + "Framework :: Pytest", + ], + packages=["ftw"], + python_requires=">=3.6", + use_scm_version=True, + setup_requires=['setuptools_scm'], + install_requires=[ + 'Brotli==1.0.7', + 'IPy==0.83', + 'PyYAML==4.2b1', + 'pytest==4.6', + 'python-dateutil==2.6.0' + ], +)