From 95808f95dbd3b16c8db5ca776baad2e45302c9f0 Mon Sep 17 00:00:00 2001 From: James Tocknell Date: Fri, 3 Mar 2017 18:40:57 +1100 Subject: [PATCH] Some cleanup --- .travis.yml | 1 + MANIFEST.in | 1 + README.md | 33 +++++++++++++++++++++------------ pypi-intro.rst | 25 +++++++++++++++++++++++++ setup.py | 21 +++++++++++++++++---- 5 files changed, 65 insertions(+), 16 deletions(-) create mode 100644 pypi-intro.rst diff --git a/.travis.yml b/.travis.yml index 418d28d..55eeeb0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,6 +8,7 @@ cache: env: - TOXENV=py27 + - TOXENV=py33 - TOXENV=py34 #- TOXENV=py35 #- TOXENV=py36 diff --git a/MANIFEST.in b/MANIFEST.in index 24b7830..42ba92e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,6 @@ include versioneer.py pytest_info_collector/_version.py include README.md +include pypi-intro.rst include LICENSE.txt recursive-include docs * recursive-exclude docs/_build * diff --git a/README.md b/README.md index 28d71de..249a294 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ -[![Documentation Status](https://readthedocs.org/projects/pytest_info_collector/badge/?version=latest)](http://pytest_info_collector.readthedocs.org/en/latest/?badge=latest) -[![Build Status](https://travis-ci.org/aragilar/pytest_info_collector.svg?branch=master)](https://travis-ci.org/aragilar/pytest_info_collector) -[![Coverage Status](https://codecov.io/github/aragilar/pytest_info_collector/coverage.svg?branch=master)](https://codecov.io/github/aragilar/pytest_info_collector?branch=master) -[![Version](https://img.shields.io/pypi/v/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![License](https://img.shields.io/pypi/l/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![Wheel](https://img.shields.io/pypi/wheel/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![Format](https://img.shields.io/pypi/format/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![Supported versions](https://img.shields.io/pypi/pyversions/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![Supported implemntations](https://img.shields.io/pypi/implementation/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) -[![PyPI](https://img.shields.io/pypi/status/pytest_info_collector.svg)](https://pypi.python.org/pypi/pytest_info_collector/) +[![Documentation Status](https://readthedocs.org/projects/pytest-info-collector/badge/?version=latest)](http://pytest-info-collector.readthedocs.org/en/latest/?badge=latest) +[![Build Status](https://travis-ci.org/aragilar/pytest-info-collector.svg?branch=master)](https://travis-ci.org/aragilar/pytest-info-collector) +[![Coverage Status](https://codecov.io/github/aragilar/pytest-info-collector/coverage.svg?branch=master)](https://codecov.io/github/aragilar/pytest-info-collector?branch=master) +[![Version](https://img.shields.io/pypi/v/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![License](https://img.shields.io/pypi/l/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![Wheel](https://img.shields.io/pypi/wheel/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![Format](https://img.shields.io/pypi/format/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![Supported versions](https://img.shields.io/pypi/pyversions/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![Supported implemntations](https://img.shields.io/pypi/implementation/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +[![PyPI](https://img.shields.io/pypi/status/pytest-info-collector.svg)](https://pypi.python.org/pypi/pytest-info-collector/) +`pytest_info_collector` is a plugin for pytest providing a fixture for collecting +information from tests and displaying it, independent of the test status. -pytest_info_collector is +A simple example of this is: +```python + + def test_single(test_info): + test_info("A simple test") +``` +which would display "A simple test" at the end of the tests. Further +documentation can be found at [https://pytest-info-collector.readthedocs.io](https://pytest-info-collector.readthedocs.io). Bug reports and suggestions should be filed at -[https://github.com/aragilar/pytest_info_collector/issues](https://github.com/aragilar/pytest_info_collector/issues). +[https://github.com/aragilar/pytest-info-collector/issues](https://github.com/aragilar/pytest-info-collector/issues). diff --git a/pypi-intro.rst b/pypi-intro.rst new file mode 100644 index 0000000..970d321 --- /dev/null +++ b/pypi-intro.rst @@ -0,0 +1,25 @@ +`pytest_info_collector` is a plugin for pytest providing a fixture for collecting +information from tests and displaying it, independent of the test status. + +A simple example of this is: + +:: + + def test_single(test_info): + test_info("A simple test") + +which would display "A simple test" at the end of the tests. Further +documentation can be found at ``_. + +Bug reports and suggestions should be filed at +``_. + + +|Documentation Status| |Build Status| |Coverage Status| + +.. |Documentation Status| image:: https://readthedocs.org/projects/pytest-info-collector/badge/?version=latest + :target: http://pytest-info-collector.readthedocs.org/en/latest/?badge=latest +.. |Build Status| image:: https://travis-ci.org/aragilar/pytest-info-collector.svg?branch=master + :target: https://travis-ci.org/aragilar/pytest-info-collector +.. |Coverage Status| image:: https://codecov.io/github/aragilar/pytest-info-collector/coverage.svg?branch=master + :target: https://codecov.io/github/aragilar/pytest-info-collector?branch=master diff --git a/setup.py b/setup.py index 071e6ab..0ce5d6a 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,15 @@ from setuptools import setup import versioneer +DESCRIPTION_FILES = ["pypi-intro.rst"] + +long_description = [] +import codecs +for filename in DESCRIPTION_FILES: + with codecs.open(filename, 'r', 'utf-8') as f: + long_description.append(f.read()) +long_description = "\n".join(long_description) + setup( name="pytest-info-collector", version=versioneer.get_version(), @@ -8,10 +17,11 @@ install_requires = ["pytest"], author = "James Tocknell", author_email = "aragilar@gmail.com", - description = "Solver thing", - #license = "BSD", - #keywords = "wheel", - url = "http://pytest_info_collector.rtfd.io", + description = "pytest plugin to collect information from tests", + long_description = long_description, + license = "3-clause BSD", + keywords = "pytest testing", + url = "https://pytest-info-collector.readthedocs.io", entry_points = { 'pytest11': [ 'name_of_plugin = pytest_info_collector', @@ -19,6 +29,9 @@ }, classifiers=[ 'Framework :: Pytest', + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: BSD License', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3',