Updated the setup.py script to include dependencies

Author: ishevche

.gitignore

@@ -19,6 +19,7 @@ lib64/
 parts/
 sdist/
 var/
+.venv/
 *.egg-info/
 .installed.cfg
 *.egg

references/.gitkeep

@@ -1,10 +1,53 @@
+import os
+from pathlib import Path
 from setuptools import find_packages, setup
 
+
+def get_long_description() -> str:
+    CURRENT_DIR = Path(__file__).parent
+    return (CURRENT_DIR / "README.md").read_text(encoding="utf8")
+
+
+import xai_ranking._min_dependencies as min_deps  # noqa
+
+ver_file = os.path.join("xai_ranking", "_version.py")
+with open(ver_file) as f:
+    exec(f.read())
+
+VERSION = __version__  # noqa
+SHORT_DESCRIPTION = "Ranking Explainability Benchmark"
+LICENSE = "MIT"
+CLASSIFIERS = [
+    "Intended Audience :: Science/Research",
+    # "Intended Audience :: Developers",
+    # "License :: OSI Approved",
+    "Programming Language :: Python",
+    "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    # "Operating System :: Microsoft :: Windows",
+    # "Operating System :: POSIX",
+    # "Operating System :: Unix",
+    # "Operating System :: MacOS",
+    # "Programming Language :: Python :: 3.9",
+    # "Programming Language :: Python :: 3.10",
+    # "Programming Language :: Python :: 3.11",
+    # "Programming Language :: Python :: 3.12",
+]
+INSTALL_REQUIRES = (min_deps.tag_to_packages["metrics"],)
+EXTRAS_REQUIRE = {
+    key: value for key, value in min_deps.tag_to_packages.items() if key != "metrics"
+}
+
 setup(
-    name="xai_ranking",
-    packages=find_packages(),
-    version="0.1.0",
-    description="Ranking Explainability Benchmark",
+    name="xai-ranking",
+    version=VERSION,
+    description=SHORT_DESCRIPTION,
     author="dataresponsibly",
-    license="MIT",
+    long_description=get_long_description(),
+    long_description_content_type="text/markdown",
+    license=LICENSE,
+    classifiers=CLASSIFIERS,
+    packages=find_packages(),
+    install_requires=INSTALL_REQUIRES,
+    extras_require=EXTRAS_REQUIRE,
 )

reports/.gitkeep

@@ -0,0 +1,58 @@
+"""All minimum dependencies."""
+
+import argparse
+
+# The values are (version_spec, comma separated tags)
+dependent_packages = {
+    "numpy": ("1.20.0", "metrics, datasets, scores"),
+    "pandas": ("1.3.5", "metrics, datasets"),
+    "scipy": ("1.14.1", "metrics"),
+    "scikit-learn": ("1.2.0", "metrics"),
+
+    "pytest-cov": ("3.0.0", "tests"),
+    "flake8": ("3.8.2", "tests"),
+    "black": ("22.3", "tests"),
+    "pylint": ("2.12.2", "tests"),
+    "mypy": ("1.6.1", "tests"),
+    "sphinx": ("4.2.0", "docs"),
+
+    # dev
+    # "coverage": ("", "tests"),
+    # "click": ("", "tests"),
+
+    # nutrition labels
+    # "matplotlib" : ("", "install"),
+    # "seaborn" : ("", "install"),
+
+    # L2R
+    # "lightgbm" : ("", "install"),
+
+    # general?
+    # "xai-sharp": ("0.1.a1", "install"),
+    # "shap" : ("", "install"),
+    # "lime" : ("", "install"),
+    # "statsmodels" : ("", "install"),
+    # "ml-research" : ("", "install"),
+
+    # dataset module
+    # "openpyxl" : ("", "install"),
+    # "" : ("", "install"),
+}
+
+# create inverse mapping for setuptools
+tag_to_packages: dict = {
+    extra: [] for extra in ["install", "optional", "docs", "examples", "tests", "all", "metrics", "datasets", "scores"]
+}
+for package, (min_version, extras) in dependent_packages.items():
+    for extra in extras.split(", "):
+        tag_to_packages[extra].append("{}>={}".format(package, min_version))
+    tag_to_packages["all"].append("{}>={}".format(package, min_version))
+
+# Used by CI to get the min dependencies
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Get min dependencies for a package")
+
+    parser.add_argument("package", choices=dependent_packages)
+    args = parser.parse_args()
+    min_version = dependent_packages[args.package][0]
+    print(min_version)

reports/figures/.gitkeep

@@ -0,0 +1,23 @@
+"""
+``ShaRP`` is an open source library with the implementation of the ShaRP
+algorithm (Shapley for Rankings and Preferences).
+"""
+
+# PEP0440 compatible formatted version, see:
+# https://www.python.org/dev/peps/pep-0440/
+#
+# Generic release markers:
+#   X.Y
+#   X.Y.Z   # For bugfix releases
+#
+# Admissible pre-release markers:
+#   X.YaN   # Alpha release
+#   X.YbN   # Beta release
+#   X.YrcN  # Release Candidate
+#   X.Y     # Final release
+#
+# Dev branch marker is: 'X.Y.dev' or 'X.Y.devN' where N is an integer.
+# 'X.Y.dev0' is the canonical version of 'X.Y.dev'
+#
+
+__version__ = "0.1.0"