doc updates for release

Author: prohde

.gitignore

@@ -1,3 +1,5 @@
 build/
 dist/
 diefpy.egg-info/
+*.pyc
+.pypirc

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Maribel Acosta
+Copyright (c) 2021 Philipp D. Rohde, Nikoleta Themeliotou
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Philipp D. Rohde, Nikoleta Themeliotou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,9 @@
 [![Build Status](https://github.com/SDM-TIB/diefpy/actions/workflows/testroutine.yml/badge.svg?branch=master)](https://github.com/SDM-TIB/diefpy/actions/workflows/testroutine.yml)
+[![Latest Release](http://img.shields.io/github/release/SDM-TIB/diefpy.svg)](https://github.com/SDM-TIB/diefpy/releases)
+[![Python Versions](https://img.shields.io/pypi/pyversions/diefpy)](https://pypi.org/project/diefpy)
+[![Package Format](https://img.shields.io/pypi/format/diefpy)](https://pypi.org/project/diefpy)
+[![Package Status](https://img.shields.io/pypi/status/diefpy)](https://pypi.org/project/diefpy)
+[![Package Version](https://img.shields.io/pypi/v/diefpy)](https://pypi.org/project/diefpy)
 [![DOI](https://zenodo.org/badge/109045351.svg)](https://zenodo.org/badge/latestdoi/109045351)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
@@ -13,6 +18,8 @@ dief@t and dief@k rely on the computation of the area under the curve of
 answer traces, and thus capturing the answer rate concentration over a time 
 interval.
 
+This is a fork of the [original diefpy repo](https://github.com/maribelacosta/diefpy) providing a complete Python3 version.
+
 ### Description
 
 ![alt text](docs/diefpy-overview.png "Overview of Result Plots")
@@ -77,6 +84,6 @@ diefpy.plot_all_continuous_efficiency_with_diefk(exp2, ["#ECC30B","#D56062","#84
 ```
 
 ### Publications
-[1] Maribel Acosta, Maria-Esther Vidal, York Sure-Vetter. Diefficiency Metrics: Measuring the Continuous Efficiency of Query Processing Approaches. In Proceedings of the International Semantic Web Conference, 2017. Nominated to Best Paper Award at the Resource Track. 
+[1] Maribel Acosta, Maria-Esther Vidal, York Sure-Vetter. Diefficiency Metrics: Measuring the Continuous Efficiency of Query Processing Approaches. In Proceedings of the International Semantic Web Conference, 2017. Nominated to Best Paper Award at the Resource Track. [https://doi.org/10.1007/978-3-319-68204-4_1](https://doi.org/10.1007/978-3-319-68204-4_1)
 
-[2] Maribel Acosta, Maria-Esther Vidal. Measuring the Performance of Continuous Query Processing Approaches with dief@t and dief@k. In  the International Semantic Web Conference, Posters and Demos, 2017.
+[2] Maribel Acosta, Maria-Esther Vidal. Measuring the Performance of Continuous Query Processing Approaches with dief@t and dief@k. In  the International Semantic Web Conference, Posters and Demos, 2017. [online](https://iswc2017.ai.wu.ac.at/wp-content/uploads/papers/PostersDemos/paper602.pdf)

docs/diefpy-overview.png

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.cfg

@@ -7,24 +7,29 @@ def readme():
 
 
 setup(name='diefpy',
-      version='0.2',
+      version='1.0.0',
       packages=['diefpy'],
-      url='https://github.com/maribelacosta/diefpy',
       license='MIT',
-      author='Maribel Acosta',
-      author_email='[email protected]',
+      author='Philipp D. Rohde, Nikoleta Themeliotou',
+      author_email='[email protected]',
+      url = 'https://github.com/SDM-TIB/diefpy',
+      download_url = 'https://github.com/SDM-TIB/diefpy/archive/refs/tags/v1.0.0.tar.gz',
       description='Python package for computing diefficiency metrics dief@t and dief@k.',
       keywords='metrics benchmarking efficiency diefficiency-metrics dief python',
       install_requires=['matplotlib==3.2.2', 'numpy>=1.8.0'],
       include_package_data=True,
       package_data={'dief': ['data/*']},
-      python_requires='>3.6',
+      python_requires='>=3.6',
       classifiers=[
-            'Development Status :: 4 - Beta',
+            'Development Status :: 5 - Production/Stable',
             'Framework :: Matplotlib',
             'Programming Language :: Python',
             'Programming Language :: Python :: 3',
             'Programming Language :: Python :: 3 :: Only',
+            'Programming Language :: Python :: 3.6',
+            'Programming Language :: Python :: 3.7',
+            'Programming Language :: Python :: 3.8',
+            'Programming Language :: Python :: 3.9',
             'License :: OSI Approved :: MIT License',
             'Topic :: System :: Benchmark',
             'Typing :: Typed'