Merge pull request #13 from martindurant/data-stubs

Add data stubs

Author: martindurant

src/projspec/content/data.py

@@ -0,0 +1,13 @@
+"""Contents specifying datasets"""
+
+from projspec.content import BaseContent
+
+
+class FrictionlessData(BaseContent):
+    # typically in a datapackage.json spec
+    ...
+
+
+class IntakeCatalog(BaseContent):
+    # typically in a catalog.yaml free-floating file
+    ...

src/projspec/proj/base.py

@@ -202,6 +202,8 @@ def _repr_html_(self):
     def from_dict(dic):
         from projspec.utils import from_dict
 
+        if not dic.get("klass", "") == "project":
+            raise ValueError("Not a project dict")
         proj = object.__new__(Project)
         proj.specs = from_dict(dic["specs"], proj)
         proj.children = from_dict(dic["children"], proj)

src/projspec/proj/datapackage.py

@@ -0,0 +1,16 @@
+from projspec.proj import ProjectSpec
+
+
+class DataPackage(ProjectSpec):
+    # by frictionless data
+
+    spec_doc = "https://datapackage.org/standard/data-package/#structure"
+    # e.g., as exported by zenodo
+    # only tabular data; docs suggest csv, xls, json filetypes; JSON
+    # can be inline in the metadata. sqlite and yaml are also mentioned.
+
+    def match(self) -> bool:
+        return "datapackage.json" in self.proj.basenames
+
+    # pythonic API
+    # https://framework.frictionlessdata.io/docs/framework/actions.html

src/projspec/proj/uv.py

@@ -154,16 +154,18 @@ def parse(self):
         if lock:
             pkg = [f"python {lock['requires-python']}"]
             # TODO: check for source= packages as opposed to pip wheel installs
-            pkg.extend(
-                [
-                    f"{_['name']} =={_.get('version', '')}"
-                    for _ in lock["package"]
-                ]
-            )
+            pkg.extend([f"{_['name']}{_vers(_)}" for _ in lock["package"]])
             self.contents.environment["lockfile"] = Environment(
                 proj=self.proj,
                 stack=Stack.PIP,
                 precision=Precision.LOCK,
                 packages=pkg,
                 artifacts={self._artifacts["virtual_env"]["default"]},
             )
+
+
+def _vers(s: dict) -> str:
+    # TODO: this may be useful elsewhere
+    if s.get("version"):
+        return f" =={s.get('version')}"
+    return ""

tests/test_basic.py

@@ -2,6 +2,8 @@
 import os.path
 import pickle
 
+import pytest
+
 import projspec.utils
 
 here = os.path.dirname(__file__)
@@ -17,6 +19,11 @@ def test_basic():
     proj._repr_html_()
 
 
+def test_errors():
+    with pytest.raises(ValueError):
+        projspec.Project.from_dict({})
+
+
 def test_contains():
     from projspec.artifact.installable import Wheel