From 2aba6ff4793c90da03e0616c12369d505f108fd4 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Tue, 6 Aug 2019 11:05:32 +0100 Subject: [PATCH 1/2] Add changelog This will help users (such as me!) when upgrading. I built it from what I could see in the existing Git history. It's naturally missing changes for my open PR's, if they are merged I'll add history entries. I copied the method of having a separate file but combining for PyPI from my open source projects such as Pytest plugin pytest-randomly: https://github.com/pytest-dev/pytest-randomly/blob/master/HISTORY.rst I checked rendering both with a local reStructuredText render in my browser and with `python setup.py clean sdist bdist_wheel` plus `twine check dist/*`. --- .gitignore | 1 + HISTORY.rst | 38 ++++++++++++++++++++++++++++++++++++++ README.rst | 6 +++--- setup.py | 2 +- 4 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 HISTORY.rst diff --git a/.gitignore b/.gitignore index 4595b1d..9d6d256 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ __pycache__ *.egg-info .pytest_cache +build dist .tox .venv diff --git a/HISTORY.rst b/HISTORY.rst new file mode 100644 index 0000000..4b37e39 --- /dev/null +++ b/HISTORY.rst @@ -0,0 +1,38 @@ +History +------- + +Pending Release +~~~~~~~~~~~~~~~ + +.. Insert new release notes below this line + +0.2 (2019-03-28) +~~~~~~~~~~~~~~~~ + +* Obey terminal width. + +0.0.4 (2018-08-26) +~~~~~~~~~~~~~~~~~~ + +* Fix for short expressions + (`Issue #6 `__). + +0.0.3 (2018-08-10) +~~~~~~~~~~~~~~~~~~ + +* Add Conda Forge installation and badge + (`PR #2 `__). +* Fix PyPI License classifier + (`Issue #3 `__). +* Fix colorization when both sides contain differences + (`Issue #4 `__). + +0.0.2 (2018-08-08) +~~~~~~~~~~~~~~~~~~ + +* Fix Travis link in README. + +0.0.1 (2018-08-08) +~~~~~~~~~~~~~~~~~~ + +* First release on PyPI. diff --git a/README.rst b/README.rst index a0b3109..c6903aa 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,11 @@ -=============== +============= pytest-icdiff -=============== +============= .. image:: https://img.shields.io/pypi/v/pytest-icdiff.svg :target: https://pypi.org/project/pytest-icdiff :alt: PyPI version - + .. image:: https://img.shields.io/conda/vn/conda-forge/pytest-icdiff.svg :target: https://anaconda.org/conda-forge/pytest-icdiff :alt: conda-forge version diff --git a/setup.py b/setup.py index 62355e5..44a851a 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ def read(fname): license='GNU GPL v3.0', url='https://github.com/hjwp/pytest-icdiff', description='use icdiff for better error messages in pytest assertions', - long_description=read('README.rst'), + long_description=read('README.rst') + read('HISTORY.rst'), py_modules=['pytest_icdiff'], python_requires='>=3.6', install_requires=['pytest', 'icdiff', 'pprintpp'], From 28a0d1af6605b4307ac335e632d6fe017420a292 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Thu, 19 Dec 2019 23:09:30 +0000 Subject: [PATCH 2/2] MANIFEST.in entry --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) diff --git a/MANIFEST.in b/MANIFEST.in index 1ade348..9cbf8c3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,5 @@ include LICENSE +include HISTORY.rst include README.rst recursive-exclude * __pycache__