Rename and start docs

Author: cthoyt

docs/source/api.rst

@@ -2,5 +2,4 @@ API Reference
 =============
 
 .. automodapi:: curies
-    :no-inheritance-diagram:
     :no-heading:

docs/source/converter_with_preprocessing.rst

@@ -0,0 +1,8 @@
+Converter with Preprocessing
+============================
+
+When simple expansion and contraction aren't enough, and you want to
+inject global or context-specific rewrite rules, you can wrap a :class:`curies.Converter`
+and preprocessing rules encoded in an instance of :class:`curies.PreprocessingRules` inside
+a :class:`curies.PreprocessingConverter`.
+

docs/source/index.rst

@@ -68,3 +68,4 @@ The most recent code and data can be installed directly from GitHub with:
     services/index
     typing
     w3c
+    converter_with_preprocessing

src/curies/__init__.py

@@ -35,6 +35,7 @@
 )
 from .triples import Triple
 from .version import get_version
+from .wrapped import PreprocessingConverter, PreprocessingRules
 
 __all__ = [
     "Converter",
@@ -45,6 +46,8 @@
     "NamedReference",
     "Prefix",
     "PrefixMap",
+    "PreprocessingConverter",
+    "PreprocessingRules",
     "Record",
     "Records",
     "Reference",

src/curies/wrapped.py

@@ -15,8 +15,8 @@
     "Blacklist",
     "BlacklistError",
     "PreprocessingConverter",
+    "PreprocessingRules",
     "Rewrites",
-    "Rules",
 ]
 
 X = TypeVar("X", bound=Reference)
@@ -121,7 +121,7 @@ def remap_prefix(self, str_or_curie_or_uri: str, ontology_prefix: str | None = N
         return str_or_curie_or_uri
 
 
-class Rules(BaseModel):
+class PreprocessingRules(BaseModel):
     """A model for blacklists and rewrites."""
 
     blacklists: Blacklist
@@ -166,10 +166,10 @@ def remap_prefix(self, str_or_curie_or_uri: str, ontology_prefix: str | None = N
         return self.rewrites.remap_prefix(str_or_curie_or_uri, ontology_prefix=ontology_prefix)
 
 
-def _load_rules(rules: str | Path | Rules) -> Rules:
+def _load_rules(rules: str | Path | PreprocessingRules) -> PreprocessingRules:
     if isinstance(rules, (str, Path)):
         rules = Path(rules).expanduser().resolve()
-        rules = Rules.model_validate_json(rules.read_text())
+        rules = PreprocessingRules.model_validate_json(rules.read_text())
     return rules
 
 
@@ -183,7 +183,7 @@ class PreprocessingConverter(Converter):
     def __init__(
         self,
         *args: Any,
-        rules: Rules | str | Path,
+        rules: PreprocessingRules | str | Path,
         reference_cls: type[X] | None = None,
         **kwargs: Any,
     ) -> None:
@@ -199,7 +199,7 @@ def __init__(
         self._reference_cls = Reference if reference_cls is None else reference_cls
 
     @classmethod
-    def from_converter(cls, converter: Converter, rules: Rules | str | Path) -> Self:
+    def from_converter(cls, converter: Converter, rules: PreprocessingRules | str | Path) -> Self:
         """Wrap a converter with a ruleset."""
         return cls(records=converter.records, rules=rules)
 

tests/test_wrapped.py

@@ -8,7 +8,13 @@
 from typing import ClassVar
 
 from curies import Converter, ReferenceTuple
-from curies.wrapped import Blacklist, BlacklistError, PreprocessingConverter, Rewrites, Rules
+from curies.wrapped import (
+    Blacklist,
+    BlacklistError,
+    PreprocessingConverter,
+    PreprocessingRules,
+    Rewrites,
+)
 
 EX1_RT = ReferenceTuple("GO", "1234567")
 EX1_URI = "http://purl.obolibrary.org/obo/GO_1234567"
@@ -21,7 +27,7 @@
 class TestWrapped(unittest.TestCase):
     """Tests for preprocessing converter."""
 
-    rules: ClassVar[Rules]
+    rules: ClassVar[PreprocessingRules]
     inner_converter: ClassVar[Converter]
     converter: ClassVar[PreprocessingConverter]
     temporary_directory: ClassVar[tempfile.TemporaryDirectory[str]]
@@ -31,7 +37,7 @@ class TestWrapped(unittest.TestCase):
     @classmethod
     def setUpClass(cls) -> None:
         """Set up the test case."""
-        cls.rules = Rules(
+        cls.rules = PreprocessingRules(
             rewrites=Rewrites(
                 full={"is_a": "rdf:type"},
                 prefix={