Element for the first release

.gitignore

@@ -16,6 +16,8 @@ docs/_build/
 docs/src/generated/
 docs/src/sg_execution_times.rst
 tools/documentation_developer/CONTRIBUTING.rst
+tools/documentation_developer/CONTRIBUTORS.rst
+docs/src/whats_news/CHANGELOG.rst
 
 # file generated by hatch
 src/hidimstat/_version.py

CHANGELOG.rst

@@ -0,0 +1,25 @@
+=================================
+Version 1.1 (under devellopement)
+=================================
+
+HIGHLIGHTS
+----------
+
+
+New features
+------------
+
+
+Changes
+-------
+
+
+Bug fixes
+---------
+
+
+Maintenance
+-----------
+
+Contributors
+------------

CONTRIBUTOR.rst

@@ -0,0 +1,32 @@
+Version 0.1.0 (see https://github.com/ja-che/hidimstat)
+-------------------------------------------------------
+https://github.com/ja-che
+https://github.com/tbng
+https://github.com/agramfort
+https://github.com/GuillaumeFavelier
+
+Version 0.1.1 (see https://github.com/Parietal-INRIA/hidimstat)
+---------------------------------------------------------------
+https://github.com/tbng
+https://github.com/bthirion
+https://github.com/achamma723
+
+Version 0.2.0
+-------------
+https://github.com/tbng
+https://github.com/bthirion
+https://github.com/achamma723
+
+Version 1.0.0
+-------------
+https://github.com/bthirion
+https://github.com/AngelReyero
+https://github.com/jpaillard
+https://github.com/lionelkusch
+https://github.com/tbng
+https://github.com/Remi-Gau
+https://github.com/jeromedockes
+https://github.com/glemaitre
+https://github.com/antoinebaker
+https://github.com/man-shu
+https://github.com/alexblnn

docs/Makefile

@@ -62,6 +62,9 @@ clean:
 	rm -rfv $(BUILDDIR)/*
 	rm -rfv $(SOURCEDIR)/generated/*
 	rm -rfv $(SOURCEDIR)/sg_execution_times.rst
+	rm -rfv $(SOURCEDIR)/whats_news/CHANGELOG.rst
+	rm -rfv $(SOURCEDIR)/dev/CONTRIBUTING.rst
+	rm -rfv $(SOURCEDIR)/dev/CONTRIBUTORS.rst
 
 html-noplot:
 	$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

docs/src/index.rst

@@ -135,4 +135,5 @@ References
   user_guide
   generated/gallery/examples/index
   glossary_and_notations
+  whats_news/whats_news
   dev/index

docs/src/whats_news/latest.rst

@@ -0,0 +1 @@
+v1.0.0.rst

docs/src/whats_news/v1.0.0.rst

@@ -0,0 +1,3 @@
+==============
+Version 1.0.0
+==============

docs/src/whats_news/whats_news.rst

@@ -0,0 +1,30 @@
+.. _whats_new:
+
+==========
+What's new
+==========
+
+====================
+Latest modification
+====================
+
+.. _latest:
+.. include:: latest.rst
+
+.. _changelog:
+.. include:: CHANGELOG.rst
+
+
+=======================
+History of modification
+=======================
+
+.. _v1.0.0:
+.. include:: v1.0.0.rst
+
+.. toctree::
+  :hidden:
+  :maxdepth: 1
+
+  v1.0.0
+  latest

docs/tools/_templates/CHANGELOG.rst

@@ -0,0 +1,25 @@
+=================================
+Version X.Y.Z (under devellopement)
+=================================
+
+HIGHLIGHTS
+----------
+
+
+New features
+------------
+
+
+Changes
+-------
+
+
+Bug fixes
+---------
+
+
+Maintenance
+-----------
+
+Contributors
+------------

docs/tools/conf.py

@@ -28,6 +28,8 @@
 # We avoid duplicating the information, but we do not use symlinks to be
 # able to build the docs on Windows
 shutil.copyfile("../../CONTRIBUTING.rst", "../src/dev/CONTRIBUTING.rst")
+shutil.copyfile("../../CONTRIBUTOR.rst", "../src/dev/CONTRIBUTORS.rst")
+shutil.copyfile("../../CHANGELOG.rst", "../src/whats_news/CHANGELOG.rst")
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -95,6 +97,12 @@
     "header_links_before_dropdown": 4,
     "pygments_light_style": "sas",
     "pygments_dark_style": "monokai",
+    "switcher": {
+        "json_url": (
+            "https://raw.githubusercontent.com/mind_inria/hidimstat/main/doc_conf/version.json"
+        ),
+        "version_match": release,
+    },
 }
 
 html_title = "HiDimStat"

docs/tools/version.json

@@ -0,0 +1,33 @@
+[
+    {
+        "name": "1.1.dev0 (dev)",
+        "version": "1.1.dev0",
+        "url": "https://hidimstat.github.io/dev/"
+    },
+    {
+        "name": "1.0 (stable)",
+        "version": "1.0",
+        "url": "https://hidimstat.github.io/stable/",
+        "preferred": true
+    },
+    {
+        "name": "1.0 (stable)",
+        "version": "1.0",
+        "url": "https://hidimstat.github.io/1.0/"
+    },
+    {
+        "name": "0.2.0",
+        "version": "0.2.0",
+        "url": "https://hidimstat.github.io/0.2/"
+    },
+    {
+        "name": "0.1.1",
+        "version": "0.1.1",
+        "url": "https://hidimstat.github.io/0.1.1/"
+    },
+    {
+        "name": "0.1.0",
+        "version": "0.1.0",
+        "url": "https://hidimstat.github.io/0.1.0/"
+    }
+]

pyproject.toml

@@ -1,40 +1,50 @@
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
-build-backend = "hatchling.build"
+requires = [
+    "setuptools             >= 64, < 100", # builder for python packages 
+    "setuptools_scm[toml]   >= 8,     < 50"  # plugging for getting the version from github
+    ]
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "HiDimStat"
-# Version from setuptools_scm
-dynamic = ["version"]
-dependencies = [
-    "joblib       >= 1.2.0, < 2",
-    "numpy        >= 1.25,  < 3",
-    "pandas       >= 2.2,   < 3",
-    "scikit-learn >= 1.5,   < 1.9",
-    "scipy        >= 1.9.2, < 2",
-    "tqdm         >= 4.1.0, < 5",
-]
-requires-python = ">=3.10,   < 4"
-authors = [{ name = "HiDimStat developers" }]
+dynamic = ["version"]  # dynamical version extracted from the git version
+authors = [  # TODO see if we need more details
+    { name = "HiDimStat developers" }  # possibility to add an email address
+    ]
 maintainers = [
     { name = "Bertrand Thirion", email = "[email protected]" },
 ]
+# Don't forget to have the coherence between the README and the description
 description = "High-dimensional statistical inference tools for Python"
-readme = "README.rst"
+keywords = ["statistic", "high dimension", "importance variable"]
+readme = "README.md"
+license = { file = "LICENSE" }
 classifiers = [
     "Intended Audience :: Science/Research",
     "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: Unix",
     "Operating System :: MacOS",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3:: Only",
+    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: Software Development",
     "Topic :: Scientific/Engineering",
 ]
-license = { file = "LICENSE" }
+requires-python = ">=3.10, < 4"
+dependencies = [
+    "joblib       >= 1.2.0, < 2",
+    "numpy        >= 1.25,  < 3",
+    "pandas       >= 2.2,   < 3",
+    "scikit-learn >= 1.5,   < 1.9",
+    "scipy        >= 1.9.2, < 2",
+    "tqdm         >= 4.1.0, < 5",
+]
 
 [project.optional-dependencies]
 # Requirements necessary for building the documentation
@@ -74,30 +84,28 @@ test = [
 ]
 
 [project.urls]
-Development = "https://github.com/nilearn/nilearn"
-Homepage = "https://mind-inria.github.io/hidimstat"
 Repository = "https://github.com/mind-inria/hidimstat"
+Documentation = "https://github.com/hidimstat/hidimstat.github.io"
+Teams = "https://team.inria.fr/mind/"
+Issues = "https://github.com/mind-inria/hidimstat/issues"
+Discussion = "https://github.com/mind-inria/hidimstat/discussions" # TODO see if we keep it or not
 
+# Configuration of the builder 
+[tool.setuptools]
+package-dir = {"" = "src"} # define the root of the packages as src
+
+# Configuration of static analysis
 [tool.codespell]
 builtin = "clear,rare,en-GB_to_en-US"
 skip = "./.git,*.bib,./docs/_build"
 
 [tool.isort]
 profile = "black"
-skip = ["src/hidimstat/_version.py", "docs/_build"]
-
-[tool.hatch.build.hooks.vcs]
-version-file = "src/hidimstat/_version.py"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/hidimstat"]
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
+skip = ["src/hidimstat/_version.py", "docs/_build", "build/"]
 
-[tool.hatch.version]
-source = "vcs"
+# file where the version is save
+[tool.setuptools_scm]
+version_file = "src/hidimstat/_version.py"
 
 # initialization based on the good practice of pytest
 # https://docs.pytest.org/en/stable/explanation/goodpractices.html

tools/documentation_developer/index.rst

@@ -13,10 +13,17 @@ You need more information, look here:
 - :ref:`Continuous Integration<developer_documentation_CI>`
 - :ref:`Building the documentation<developer_documentation_build>`
 
+============
+CONTRIBUTORS
+============
+.. _latest:
+.. include:: CONTRIBUTORS.rst
+
 .. toctree::
   :hidden:
 
   developer_guidelines
   how_to_contribute
   building_documentation
   CI_documentation
+  CONTRIBUTORS