Revert "CLN remove template scripts"

This reverts commit 471132d.

Author: tomMoral

README.rst

@@ -1,3 +1,16 @@
+Template for Benchopt Benchmark repositories
+=============================================
+|Build Template|
+
+This repo should be used with the following steps:
+
+1. Hit the `Use this template` button on the top of `this page <https://github.com/benchopt/template_benchmark>`_,
+2. Use the form to create a new GitHub repository with your benchmark name,
+3. Clone the newly created repository on your computer,
+4. Run ``python clean_template.py`` script that will remove instructions relative to
+   the template in ``README.rst`` and update it with your repo and org name.
+5. Edit the problem description in the ``README.rst``.
+6. Update ``objective.py`` and the files in ``datasets`` and ``solvers`` to create the benchmark.
 
 My Benchopt Benchmark
 =====================
@@ -15,14 +28,21 @@ This benchmark can be run using the following commands:
 .. code-block::
 
    $ pip install -U benchopt
+   $ git clone https://github.com/#ORG/#BENCHMARK_NAME
+   $ benchopt run #BENCHMARK_NAME
 
 Apart from the problem, options can be passed to ``benchopt run``, to restrict the benchmarks to some solvers or datasets, e.g.:
 
 .. code-block::
 
+	$ benchopt run #BENCHMARK_NAME -s solver1 -d dataset2 --max-runs 10 --n-repetitions 10
 
 
 Use ``benchopt run -h`` for more details about these options, or visit https://benchopt.github.io/api.html.
 
+.. |Build Template| image:: https://github.com/benchopt/template_benchmark_ml/workflows/Tests/badge.svg
+   :target: https://github.com/benchopt/template_benchmark_ml/actions
+.. |Build Status| image:: https://github.com/#ORG/#BENCHMARK_NAME/workflows/Tests/badge.svg
+   :target: https://github.com/#ORG/#BENCHMARK_NAME/actions
 .. |Python 3.6+| image:: https://img.shields.io/badge/python-3.6%2B-blue
    :target: https://www.python.org/downloads/release/python-360/

clean_template.py

@@ -0,0 +1,39 @@
+import re
+from pathlib import Path
+from subprocess import check_output
+
+
+if __name__ == "__main__":
+
+    # Get the name of the repo and parse org and bench name
+    repo_url = check_output(['git', 'remote', 'get-url', 'origin']).decode()
+    name = re.split('github.com[:/]', repo_url)[1].strip()
+    ORG, BENCHMARK_NAME = name.replace('.git', '').split('/')
+
+    # update readme to have the right badge
+    README = Path('README.rst')
+    text = README.read_text()
+
+    text = text.replace('#ORG', ORG)
+    text = text.replace('#BENCHMARK_NAME', BENCHMARK_NAME)
+
+    text = '\n'.join([line for line in text.splitlines()[13:]
+                      if 'template_benchmark' not in line] + [''])
+    README.write_text(text)
+
+    # update the repo URL in the objective.py file
+    file = Path("objective.py")
+    text = file.read_text()
+    text = text.replace('#ORG', ORG)
+    text = text.replace('#BENCHMARK_NAME', BENCHMARK_NAME)
+    file.write_text(text)
+
+    # Remove files specific to the template repo
+    to_remove = [
+        Path(".github") / "workflows" / "test_benchmarks.yml",
+        Path(".github") / "workflows" / "lint_benchmarks.yml",
+        Path(".") / "clean_template.py"
+    ]
+    for file in to_remove:
+        if file.exists():
+            file.unlink()

objective.py

@@ -12,7 +12,7 @@ class Objective(BaseObjective):
     name = "Template benchmark"
 
     # URL of the main repo for this benchmark.
-    url = "https://github.com/benchopt/#BENCHMARK"
+    url = "https://github.com/#ORG/#BENCHMARK"
 
     # List of parameters for the objective. The benchmark will consider
     # the cross product for each key in the dictionary.