Rangekeeper 0.8.25__tar.gz → 0.8.26__tar.gz

{rangekeeper-0.8.25 → rangekeeper-0.8.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.25
+Version: 0.8.26
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.25 → rangekeeper-0.8.26}/Rangekeeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.25
+Version: 0.8.26
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.25 → rangekeeper-0.8.26}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Rangekeeper"
-version = "0.8.25"
+version = "0.8.26"
 description = "A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis."
 authors = [
     { name = "Daniel Fink", email = "danfink@mit.edu" }

{rangekeeper-0.8.25 → rangekeeper-0.8.26}/rangekeeper/flux.py

@@ -324,21 +324,35 @@ class Flow:
             movements=frame["Discounted Flow"], units=self.units, name=name
         )
 
-    def xirr(self) -> float:
-        return pyxirr.xirr(
+    def xirr(
+        self, registry: pint.UnitRegistry = rk.measure.Index.registry
+    ) -> pint.Quantity:
+        """
+        Returns the XIRR (Extended Internal Rate of Return) of the Flow's movements.
+        Formats the result as a percentage in the specified registry's units.
+        """
+        result = pyxirr.xirr(
             dates=list(self.movements.index.array),
             amounts=self.movements.to_list(),
         )
+        return result * 100 * registry.percent
 
     def xnpv(
         self,
-        rate: float,
-    ) -> float:
-        return pyxirr.xnpv(
+        rate: Union[float, pint.Quantity],
+    ) -> pint.Quantity:
+        """
+        Returns the XNPV (Extended Net Present Value) of the Flow's movements at a specified rate.
+        Formats the result as a quantity in the Flow's units.
+        """
+        if isinstance(rate, pint.Quantity):
+            rate = rate.to(rk.measure.Index.registry.dimensionless).magnitude
+        result = pyxirr.xnpv(
             rate=rate,
             dates=list(self.movements.index.array),
             amounts=self.movements.to_list(),
         )
+        return result * self.units
 
     def diff(
         self,