switch to hatch and pyproject.toml

README.md

@@ -1,13 +1,15 @@
 # Voilà template for Materials Cloud
+
 [![PyPI - Version](https://img.shields.io/pypi/v/voila-materialscloud-template?color=4CC61E)](https://pypi.org/project/voila-materialscloud-template/)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/materialscloud-org/voila-materialscloud-template/main?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fexample.ipynb)
 
 This is the Voilà template for Materials Cloud, implements the standard header and CSS.
 
 Three templates are provided:
-* `materialscloud-tool` - highlights the [WORK](https://www.materialscloud.org/work)/Tools section in the header/breadcrumbs.
-* `materialscloud-discover` - highlights the [DISCOVER](https://www.materialscloud.org/discover) section in the header/breadcrumbs.
-* `materialscloud-iframe` - just adds a simple "Hosted on Materials Cloud" note at the bottom.
+
+- `materialscloud-tool` - highlights the [WORK](https://www.materialscloud.org/work)/Tools section in the header/breadcrumbs.
+- `materialscloud-discover` - highlights the [DISCOVER](https://www.materialscloud.org/discover) section in the header/breadcrumbs.
+- `materialscloud-iframe` - just adds a simple "Hosted on Materials Cloud" note at the bottom.
 
 ## Installation
 
@@ -24,6 +26,7 @@ The main way is to use the `voila --template` option, e.g.:
 ```bash
 voila --template=materialscloud-tool example.ipynb
 ```
+
 Alternatively, you can write a `voila.json` file containing
 
 ```json
@@ -51,7 +54,7 @@ Option 1:
 pip install -e .[dev]
 ```
 
-Note: this will copy the templates to the jupyter folder, and they need to be modified directly there or re-copied if new tests are required.
+Note: this will copy the templates to the jupyter folder, and they need to be modified directly there or re-copied for changes to take effect.
 
 Option 2:
 
@@ -69,10 +72,11 @@ Note: maybe there is an easier setup, e.g. with live-reload or similar.
 ### Making a new release
 
 To release a new version, just make a new release on Github with the correct version tag, without updating any versions manually. This will start the GitHub action that will
-* update version numbers in the repo and commits it;
-* tags this new commit with the version, overwriting the tag that was made by the Github release;
-* pushes commit & tag to Github;
-* publishes new version on PYPI.
+
+- update version numbers in the repo and commits it;
+- tags this new commit with the version, overwriting the tag that was made by the Github release;
+- pushes commit & tag to Github;
+- publishes new version on PYPI.
 
 ## License
 

docker/Dockerfile

@@ -2,10 +2,7 @@ FROM python:3.9
 
 WORKDIR /home/voila
 
-COPY requirements.txt .
-RUN pip install -r requirements.txt
-
-COPY requirements_dev.txt .
-RUN pip install -r requirements_dev.txt
+COPY pyproject.toml LICENSE.txt README.md ./
+RUN pip install .[dev]
 
 EXPOSE 8866

pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["hatchling >=1.5"]
+build-backend = "hatchling.build"
+
+[project]
+name = "voila-materialscloud-template"
+version = "0.4.1"
+description = 'Voilà template for Materials Cloud.'
+authors = [{ name = "The Materials Cloud team" }]
+urls = { Source = 'https://github.com/materialscloud-org/voila-materialscloud-template' }
+license = { file = 'LICENSE.txt' }
+readme = "README.md"
+keywords = ['voila', 'jupyter', 'materialscloud']
+classifiers = [
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+]
+
+requires-python = ">=3.8"
+dependencies = ["voila~=0.4.4", "jupyter-core~=5.3.1"]
+
+[project.optional-dependencies]
+dev = [
+  "invoke~=2.2",
+  "ipywidgets~=8.1",
+  "pylint~=2.17",
+  "jupyterlab~=4.0",
+  "widget-periodictable~=4.1",
+]
+
+[tool.hatch.build.targets.sdist]
+artifacts = ["share"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["share"]
+
+# copy the templates to the correct location
+[tool.hatch.build.targets.wheel.shared-data]
+"share/jupyter" = "share/jupyter"