Toml + Tox Migration

[aaarrti]

Description

• Migrate from deprecated setup.pyinstall to recommended by pypa (the team behind pipy) pyproject.toml, build and filt-core as build backend.
• Centralize all testing, linting, etc., configuration in tox.ini. Tox has nothing to do with packaging, it is used for test automation. At this point, the benefit is minimal, but this is a prerequisite for "integration testing". Tox will allow us to create different isolated environments with or without TensorFlow, which will help us ensure Quantus is usable in all of it's
  different installation variants.
• To ensure the packaging still works, and it won't affect users, I will add an action to do a pre-release (often called nightly release, dev release, snapshot release), and first verify it there. However, to run the action, it must be present in the main branch.

Implemented changes

• Insert a description of the changes implemented in the pull request.
  • replace setup.py with pyproject.toml
  • add tox.ini, add testing, linting, coverage configurations to it.
  • update GitHub actions to use tox environments.
  • update readme describing how to use tox for testing locally.
  • add action to do a pre-release.

Minimum acceptance criteria

• Nothing got broken
• @annahedstroem I have published in-development version to Test PyPi https://test.pypi.org/project/quantus/. Please share your username, so I can add you to the project. As for the public release process, I have added a script for it, so just run ./scripts/github_release.sh.

[codecov-commenter]

Codecov Report

Merging #270 (6055bf6) into main (f94853b) will not change coverage.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##             main     #270   +/-   ##
=======================================
  Coverage   92.87%   92.87%           
=======================================
  Files          60       60           
  Lines        3200     3200           
=======================================
  Hits         2972     2972           
  Misses        228      228           

[annahedstroem]

Mostly minor comments. Once resolved I will go about testing the installations.

[annahedstroem]

Same comment on different commands

[annahedstroem]

Can you provide a source to this file to how this file was developed?

[annahedstroem]

Not clear to me how this file is used, how is the tag chosen by the user?

[aaarrti]

You'd choose tag, e.g., v.4.0.2 and run ./scripts/github_release v.4.0.2.

[annahedstroem]

Great, can you add that running instructions ./scripts/github_release v.4.0.2 including all the build step, as a subsection in https://quantus.readthedocs.io/en/latest/docs_dev/CONTRIBUTING.html?

[annahedstroem]

In this gitub_release.sh can you provide a source to this file as a comment (to how this file was developed)?

[aaarrti]

tbh, I am not a big fan of this script either. Let's try to catch up in the following days, and talk about how would you want to organize the release process.

[annahedstroem]

In this gitub_release.sh can you provide a source to this file as a comment (to how this file was developed)?

[annahedstroem]

There is a discrepancy betwee CONTRIBUTING.md under root and under docs/. Under docs/ it is still outdated.

git clone https://github.com/understandable-machine-intelligence-lab/Quantus.git
cd quantus
pip install -r requirements_test.txt
pip install -e .

[annahedstroem]

There is a discrepancy betwee CONTRIBUTING.md under root and under docs/. Under docs/ it is still outdated.

git clone https://github.com/understandable-machine-intelligence-lab/Quantus.git
cd quantus
pip install -r requirements_test.txt
pip install -e .

I'll update this and push it.