Update APIs / internals for signac 2. (#166)

* Update init_project call for signac 2.

* Update module namespaces.

* Remove references to project root (it's called the project path now).

* Test against signac development branch.

* Update .gitignore.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Bump requirements.

* Update requirements.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/ci-oldest-reqs.txt

@@ -9,7 +9,7 @@ markupsafe==2.0.0
 natsort
 pytest
 pytest-cov
-signac==1.8.0
+signac==2.0.0
 watchdog
 webassets==2.0.0
 werkzeug==2.1.0

.gitignore

@@ -6,6 +6,7 @@ __pycache__
 signac_dashboard.egg-info/
 build/
 dist/
-.signac_sp_cache.json.gz
 doc/_*
+.signac
+.signac_sp_cache.json.gz
 .signac_shell_history

pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
     "libsass",
     "markupsafe>=2.0.0",
     "natsort",
-    "signac>=1.8.0",
+    "signac>=2.0.0",
     "watchdog",
     "webassets>=2.0.0",
     "werkzeug>=2.1.0",

requirements.txt

@@ -7,7 +7,7 @@ jsmin
 libsass
 markupsafe>=2.0.0
 natsort
-signac>=1.8.0
+signac>=2.0.0
 watchdog
 webassets>=2.0.0
 werkzeug>=2.1.0

signac_dashboard/dashboard.py

@@ -293,7 +293,7 @@ def job_title(self, job):
         (but verbose) form of the job state point, based on the project schema.
 
         :param job: The job being titled.
-        :type job: :py:class:`signac.contrib.job.Job`
+        :type job: :py:class:`signac.job.Job`
         :returns: Title to be displayed.
         :rtype: str
         """
@@ -331,7 +331,7 @@ def job_subtitle(self, job):
         minimal unique substring of the job id.
 
         :param job: The job being subtitled.
-        :type job: :py:class:`signac.contrib.job.Job`
+        :type job: :py:class:`signac.job.Job`
         :returns: Subtitle to be displayed.
         :rtype: str
         """
@@ -346,7 +346,7 @@ def job_sorter(self, job):
         strings or tuples of properties that should be used to sort.
 
         :param job: The job being sorted.
-        :type job: :py:class:`signac.contrib.job.Job`
+        :type job: :py:class:`signac.job.Job`
         :returns: Key for sorting.
         :rtype: any comparable type
         """
@@ -376,7 +376,7 @@ def _job_search(self, query):
                     f = json.loads(query)
                 except json.JSONDecodeError:
                     query = shlex.split(query)
-                    f = signac.contrib.filterparse.parse_filter_arg(query)
+                    f = signac.filterparse.parse_filter_arg(query)
                     flash(f"Search string interpreted as '{json.dumps(f)}'.")
             jobs = self.project.find_jobs(filter=f)
             return sorted(jobs, key=lambda job: self.job_sorter(job))

signac_dashboard/modules/image_viewer.py

@@ -15,7 +15,7 @@ class ImageViewer(Module):
 
     The ImageViewer module can display images in any format that works with a standard
     ``<img>`` tag. The module defaults to showing all images of PNG, JPG, GIF, and SVG
-    types in the job or project root directory. A filename or glob can be
+    types in the job or project directory. A filename or glob can be
     defined to select specific filenames. Each matching file yields a card.
 
     Multiple ImageViewer modules can be defined with different filenames or
@@ -29,13 +29,13 @@ class ImageViewer(Module):
         img_mod = ImageViewer()  # Show all PNG/JPG/GIF/SVG images
         img_mod = ImageViewer(name='Bond Order Diagram', img_globs=['bod.png'])
         img_mod = ImageViewer(context="ProjectContext",
-                              img_globs=['/gallery/*.png'])  # search subdirectory of project root
+                              img_globs=['/gallery/*.png'])  # search subdirectory of project path
 
     :param context: Supports :code:`'JobContext'` and :code:`'ProjectContext'`.
     :type context: str
     :param img_globs: A list of glob expressions or exact filenames,
-        relative to the job or project root directory, to be
-        displayed (default: :code:`['*.png', '*.jpg', '*.gif', '*.svg']`).
+        relative to the job or project directory, to be displayed
+        (default: :code:`['*.png', '*.jpg', '*.gif', '*.svg']`).
     :type img_globs: list
     :type sort_key: callable
     :param sort_key: Key to sort the image files, passed internally to :code:`sorted`.

signac_dashboard/modules/text_display.py

@@ -32,7 +32,7 @@ def my_text(job):
     :param context: Supports :code:`'JobContext'` and :code:`'ProjectContext'`.
     :type context: str
     :param message: A callable accepting one argument of type
-        :py:class:`signac.contrib.job.Job` or :py:class:`signac.Project`
+        :py:class:`signac.job.Job` or :py:class:`signac.Project`
         and returning text or Markdown content.
     :type message: callable
     :param markdown: Enables Markdown rendering if True (default: :code:`False`).

signac_dashboard/modules/video_viewer.py

@@ -15,7 +15,7 @@ class VideoViewer(Module):
 
     The VideoViewer module displays videos using an HTML ``<video>`` tag. The
     module defaults to showing all videos of MP4 or M4V types in the job or
-    project root directory. A filename or glob can be defined to select specific
+    project directory. A filename or glob can be defined to select specific
     filenames, which may be of any format supported by your browser with the
     ``<video>`` tag. Each matching file yields a card.
 
@@ -43,8 +43,8 @@ class VideoViewer(Module):
     :param context: Supports :code:`'JobContext'` and :code:`'ProjectContext'`.
     :type context: str
     :param video_globs: A list of glob expressions or exact filenames,
-        relative to the job or project root directory, to be
-        displayed (default: :code:`['*.mp4', '*.m4v']`).
+        relative to the job or project directory, to be displayed
+        (default: :code:`['*.mp4', '*.m4v']`).
     :type video_globs: list
     :param preload: Option for preloading videos, one of :code:`'auto'`,
         :code:`'metadata'`, or :code:`'none'` (default: :code:`'none'`).

tests/test_dashboard.py

@@ -21,7 +21,7 @@ def get_response(self, query):
 
     def setUp(self):
         self._tmp_dir = tempfile.mkdtemp()
-        self.project = init_project(root=self._tmp_dir, make_dir=False)
+        self.project = init_project(self._tmp_dir)
         # Set up some fake jobs
         for a in range(3):
             for b in range(2):
@@ -137,7 +137,7 @@ class AllModulesTestCase(DashboardTestCase):
 
     def setUp(self):
         self._tmp_dir = tempfile.mkdtemp()
-        self.project = init_project(root=self._tmp_dir, make_dir=False)
+        self.project = init_project(self._tmp_dir)
         # Set up some fake jobs
         for a in range(3):
             for b in range(2):