add extension functionality (see #111)

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning][].
 [keep a changelog]: https://keepachangelog.com/en/1.1.0/
 [semantic versioning]: https://semver.org/spec/v2.0.0.html
 
+## [0.3.4] (unreleased)
+
+### Added
+
+- `mudata.register_mudata_namespace()` functionality for adding custom functionality to `MuData` objects.
+
 ## [0.3.3]
 
 ### Fixed
@@ -129,7 +135,8 @@ To copy the annotations explicitly, you will need to use `pull_obs()` and/or `pu
 
 Initial `mudata` release with `MuData`, previously a part of the `muon` framework.
 
-[0.3.3]: https://github.com/scverse/mudata/compare/v0.3.1...v0.3.3
+[0.3.4]: https://github.com/scverse/mudata/compare/v0.3.3...v0.3.4
+[0.3.3]: https://github.com/scverse/mudata/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/scverse/mudata/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/scverse/mudata/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/scverse/mudata/compare/v0.2.4...v0.3.0

docs/api.md

@@ -30,3 +30,12 @@
    :functions-only:
    :toctree: generated
 ```
+
+## Extensions
+```{eval-rst}
+.. module::mudata
+.. autosummary::
+   :toctree: generated
+
+   register_mudata_namespace
+```

pyproject.toml

@@ -34,6 +34,7 @@ dependencies = [
   "numpy",
   "pandas>=1.4",
   "scipy",
+  "scverse-misc",
   # for debug logging (referenced from the issue template)
   "session-info2",
 ]

src/mudata/__init__.py

@@ -1,6 +1,8 @@
 """Multimodal datasets"""
 
 from anndata import AnnData
+from scverse_misc import ExtensionNamespace
+from scverse_misc import make_register_namespace_decorator as _make_register_namespace_decorator
 
 from ._core import utils
 from ._core.config import set_options
@@ -25,6 +27,8 @@
 __anndataversion__ = "0.1.0"
 __mudataversion__ = "0.1.0"
 
+register_mudata_namespace = _make_register_namespace_decorator(MuData, "mdata", "register_mudata_namespace", "numpy")
+
 __all__ = [
     "__version__",
     "MuData",