PyPI - return-scenario-engine - Versions diffs - 0.1.0__tar.gz - Mend

return-scenario-engine 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

return_scenario_engine-0.1.0/LICENSE ADDED Viewed

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright [yyyy] [name of copyright owner]
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

return_scenario_engine-0.1.0/NOTICE ADDED Viewed

@@ -0,0 +1,5 @@
+Gale Finance Open Source Software
+Copyright 2026 Sid Kalla
+This product includes software originally developed by Sid Kalla for
+Gale Finance (https://gale.finance/).

return_scenario_engine-0.1.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: return-scenario-engine
+Version: 0.1.0
+Summary: Portable historical return scenario calculations
+Author: Sid Kalla
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+           1. Definitions.
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+           END OF TERMS AND CONDITIONS
+           APPENDIX: How to apply the Apache License to your work.
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+           Copyright [yyyy] [name of copyright owner]
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+               http://www.apache.org/licenses/LICENSE-2.0
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+Project-URL: Homepage, https://github.com/sidko/return-scenario-engine
+Project-URL: Repository, https://github.com/sidko/return-scenario-engine
+Project-URL: Issues, https://github.com/sidko/return-scenario-engine/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: test
+Requires-Dist: build>=1.2; extra == "test"
+Dynamic: license-file
+# return-scenario-engine (Python)
+The Python distribution provides the same dependency-free normalized-index
+scenario API, methodology JSON, public SHA-256 hash, and synthetic golden corpus
+as the TypeScript package. Install with `python -m pip install
+return-scenario-engine`, then call `calculate_scenario` with explicit artifact
+dictionaries. Full contract, limits, examples, and security guidance are in the
+[repository README](https://github.com/sidko/return-scenario-engine#readme).
+```python
+from return_scenario_engine import calculate_scenario
+dates = ["2024-01-01", "2024-01-02", "2024-01-03"]
+base = {"schemaVersion": 1, "methodologyVersion": "return-scenario-v1.0.0", "seriesBasis": "close_index", "annualizationFactor": 365, "dates": dates}
+result = calculate_scenario({"amountCents": 100_000, "requestedStart": dates[0], "requestedEnd": dates[-1], "assetA": base | {"assetKey": "sample-a", "growthIndex": [100, 110, 121]}, "assetB": base | {"assetKey": "sample-b", "growthIndex": [100, 95, 100]}})
+assert result["status"] == "ok"
+```

return_scenario_engine-0.1.0/README.md ADDED Viewed

@@ -0,0 +1,17 @@
+# return-scenario-engine (Python)
+The Python distribution provides the same dependency-free normalized-index
+scenario API, methodology JSON, public SHA-256 hash, and synthetic golden corpus
+as the TypeScript package. Install with `python -m pip install
+return-scenario-engine`, then call `calculate_scenario` with explicit artifact
+dictionaries. Full contract, limits, examples, and security guidance are in the
+[repository README](https://github.com/sidko/return-scenario-engine#readme).
+```python
+from return_scenario_engine import calculate_scenario
+dates = ["2024-01-01", "2024-01-02", "2024-01-03"]
+base = {"schemaVersion": 1, "methodologyVersion": "return-scenario-v1.0.0", "seriesBasis": "close_index", "annualizationFactor": 365, "dates": dates}
+result = calculate_scenario({"amountCents": 100_000, "requestedStart": dates[0], "requestedEnd": dates[-1], "assetA": base | {"assetKey": "sample-a", "growthIndex": [100, 110, 121]}, "assetB": base | {"assetKey": "sample-b", "growthIndex": [100, 95, 100]}})
+assert result["status"] == "ok"
+```

return_scenario_engine-0.1.0/pyproject.toml ADDED Viewed

@@ -0,0 +1,28 @@
+[project]
+name = "return-scenario-engine"
+version = "0.1.0"
+requires-python = ">=3.11"
+description = "Portable historical return scenario calculations"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [{name = "Sid Kalla"}]
+classifiers = ["Programming Language :: Python :: 3", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12"]
+[project.urls]
+Homepage = "https://github.com/sidko/return-scenario-engine"
+Repository = "https://github.com/sidko/return-scenario-engine"
+Issues = "https://github.com/sidko/return-scenario-engine/issues"
+[project.optional-dependencies]
+test = ["build>=1.2"]
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+[tool.setuptools]
+packages = ["return_scenario_engine", "return_scenario_engine.methodology"]
+license-files = ["LICENSE", "NOTICE"]
+[tool.setuptools.package-data]
+return_scenario_engine = ["methodology/*.json"]

return_scenario_engine-0.1.0/return_scenario_engine/__init__.py ADDED Viewed

@@ -0,0 +1,481 @@
+"""Portable public return-scenario calculations for normalized index artifacts."""
+from __future__ import annotations
+from datetime import date
+from decimal import Decimal, ROUND_HALF_UP
+import math
+import re
+from typing import Any
+ARTIFACT_SCHEMA_VERSION = 1
+METHODOLOGY_VERSION = "return-scenario-v1.0.0"
+METHODOLOGY_HASH = "55ef9001eb8795071cfff1e135430d41952aedd8708ba1d767c3453804fd49b0"
+SUPPORTED_SERIES_BASES = frozenset({"close_index", "adjusted_close_index"})
+DEFAULT_FIXTURE_SERIES_BASIS = "close_index"
+MIN_AMOUNT_CENTS = 100
+MAX_AMOUNT_CENTS = 1_000_000_000
+DATE_RE = re.compile(r"^\d{4}-\d{2}-\d{2}$")
+CAGR_DAY_COUNT = 365.25
+CALMAR_MIN_ABS_DRAWDOWN = 0.0001
+ZERO_VARIANCE_SUMSQ_EPSILON = 1e-24
+CORRELATION_CLAMP_TOLERANCE = 1e-12
+def metric_available(value: float, display: dict[str, Any] | None = None) -> dict[str, Any]:
+    if not math.isfinite(value):
+        return metric_unavailable("nonfinite_result")
+    output: dict[str, Any] = {"available": True, "value": normalize_zero(value)}
+    if display:
+        output.update(display)
+    return output
+def metric_unavailable(reason: str) -> dict[str, Any]:
+    return {"available": False, "reason": reason}
+def normalize_zero(value: float) -> float:
+    return 0.0 if value == 0 else value
+def round_half_away_from_zero(value: float, scale: int = 1) -> int:
+    if not math.isfinite(value):
+        raise ValueError("cannot round nonfinite value")
+    if isinstance(scale, bool) or not isinstance(scale, int) or scale <= 0 or scale > 9_007_199_254_740_991:
+        raise ValueError("scale must be a positive safe integer")
+    sign = -1 if value < 0 else 1
+    rounded = (Decimal(str(abs(value))) * Decimal(scale)).to_integral_value(rounding=ROUND_HALF_UP)
+    result = int(rounded)
+    if result > 9_007_199_254_740_991:
+        raise ValueError("rounded result exceeds safe integer range")
+    return sign * result
+def display_cents(usd_value: float) -> int:
+    return round_half_away_from_zero(usd_value, 100)
+def display_basis_points(decimal_value: float) -> int:
+    return round_half_away_from_zero(decimal_value, 10_000)
+def display_hundredths(ratio_value: float) -> int:
+    return round_half_away_from_zero(ratio_value, 100)
+def is_valid_civil_date(value: str) -> bool:
+    if not isinstance(value, str) or not DATE_RE.match(value):
+        return False
+    try:
+        parsed = date.fromisoformat(value)
+    except ValueError:
+        return False
+    return parsed.isoformat() == value
+def parse_civil_date(value: str) -> date:
+    if not is_valid_civil_date(value):
+        raise ValueError(f"invalid civil date: {value}")
+    return date.fromisoformat(value)
+def civil_day(value: str) -> int:
+    return parse_civil_date(value).toordinal()
+def first_anniversary(value: str) -> str:
+    parsed = parse_civil_date(value)
+    try:
+        anniversary = parsed.replace(year=parsed.year + 1)
+    except ValueError:
+        anniversary = date(parsed.year + 1, 2, 28)
+    return anniversary.isoformat()
+def parse_usd_amount_to_cents(value: str) -> dict[str, Any]:
+    if not isinstance(value, str):
+        return {"ok": False, "reason": "invalid_amount"}
+    raw = re.sub(r"^\$\s*", "", value.strip())
+    plain_amount = re.compile(r"^(0|[1-9][0-9]*)(\.[0-9]{1,2})?$")
+    grouped_amount = re.compile(r"^(0|[1-9][0-9]{0,2}(,[0-9]{3})+)(\.[0-9]{1,2})?$")
+    if not plain_amount.match(raw) and not grouped_amount.match(raw):
+        return {"ok": False, "reason": "invalid_amount"}
+    dollars, _, cents = raw.replace(",", "").partition(".")
+    parsed = int(dollars) * 100 + int(cents.ljust(2, "0") or "0")
+    if parsed < MIN_AMOUNT_CENTS or parsed > MAX_AMOUNT_CENTS:
+        return {"ok": False, "reason": "invalid_amount"}
+    return {"ok": True, "cents": parsed}
+parse_amount_to_cents = parse_usd_amount_to_cents
+def ordered_sum(values: list[float]) -> float:
+    """Accumulate in input order to match the JavaScript implementation."""
+    total = 0.0
+    for value in values:
+        total += value
+    return total
+def ordered_mean(values: list[float]) -> float:
+    return ordered_sum(values) / len(values)
+def sample_variance(values: list[float]) -> float | None:
+    if len(values) < 2:
+        return None
+    mean = ordered_mean(values)
+    squared_deviation_sum = 0.0
+    for value in values:
+        squared_deviation_sum += (value - mean) ** 2
+    return squared_deviation_sum / (len(values) - 1)
+def sample_stddev(values: list[float]) -> float | None:
+    variance = sample_variance(values)
+    return math.sqrt(variance) if variance is not None else None
+def simple_returns(values: list[float]) -> list[float]:
+    returns: list[float] = []
+    for index in range(1, len(values)):
+        previous = values[index - 1]
+        current = values[index]
+        if previous <= 0 or current <= 0:
+            raise ValueError("normalized indexes must be positive")
+        returns.append(current / previous - 1)
+    return returns
+def asset_values(asset: dict[str, Any]) -> list[Any]:
+    return asset.get("growthIndex")
+def pearson_correlation(values_a: list[float], values_b: list[float]) -> dict[str, Any]:
+    if len(values_a) != len(values_b) or len(values_a) < 2:
+        return metric_unavailable("insufficient_data")
+    mean_a = ordered_mean(values_a)
+    mean_b = ordered_mean(values_b)
+    covariance = 0.0
+    sum_sq_a = 0.0
+    sum_sq_b = 0.0
+    for value_a, value_b in zip(values_a, values_b):
+        delta_a = value_a - mean_a
+        delta_b = value_b - mean_b
+        covariance += delta_a * delta_b
+        sum_sq_a += delta_a * delta_a
+        sum_sq_b += delta_b * delta_b
+    if sum_sq_a <= ZERO_VARIANCE_SUMSQ_EPSILON or sum_sq_b <= ZERO_VARIANCE_SUMSQ_EPSILON:
+        return metric_unavailable("zero_variance")
+    correlation = covariance / math.sqrt(sum_sq_a * sum_sq_b)
+    if abs(abs(correlation) - 1) <= CORRELATION_CLAMP_TOLERANCE:
+        correlation = 1.0 if correlation > 0 else -1.0
+    elif correlation < -1 or correlation > 1:
+        return metric_unavailable("nonfinite_result")
+    return metric_available(correlation, {"displayHundredths": display_hundredths(correlation)})
+def drawdown_stats(values: list[float], dates: list[str]) -> dict[str, Any]:
+    if len(values) < 2:
+        return {
+            "maxDrawdown": metric_unavailable("insufficient_data"),
+            "peakDate": None,
+            "troughDate": None,
+            "recoveryDate": None,
+            "recoveryDays": None,
+            "recoveryStatus": "not_applicable",
+        }
+    running_peak = values[0]
+    running_peak_at_trough = values[0]
+    trough_index = 0
+    max_drawdown = 0.0
+    for index, value in enumerate(values):
+        if value >= running_peak:
+            running_peak = value
+        drawdown = value / running_peak - 1
+        if drawdown < max_drawdown:
+            max_drawdown = drawdown
+            trough_index = index
+            running_peak_at_trough = running_peak
+    if max_drawdown == 0:
+        return {
+            "maxDrawdown": metric_available(0.0, {"displayBasisPoints": 0}),
+            "peakDate": None,
+            "troughDate": None,
+            "recoveryDate": None,
+            "recoveryDays": None,
+            "recoveryStatus": "not_applicable",
+        }
+    peak_index = 0
+    for index in range(0, trough_index + 1):
+        if values[index] == running_peak_at_trough:
+            peak_index = index
+    recovery_index = None
+    for index in range(trough_index, len(values)):
+        if values[index] >= running_peak_at_trough:
+            recovery_index = index
+            break
+    return {
+        "maxDrawdown": metric_available(max_drawdown, {"displayBasisPoints": display_basis_points(max_drawdown)}),
+        "peakDate": dates[peak_index],
+        "troughDate": dates[trough_index],
+        "recoveryDate": dates[recovery_index] if recovery_index is not None else None,
+        "recoveryDays": civil_day(dates[recovery_index]) - civil_day(dates[trough_index]) if recovery_index is not None else None,
+        "recoveryStatus": "recovered" if recovery_index is not None else "not_recovered",
+    }
+def validate_asset(asset: dict[str, Any]) -> bool:
+    asset_key = asset.get("assetKey")
+    if not isinstance(asset_key, str) or not asset_key:
+        return False
+    series_basis = asset.get("seriesBasis")
+    if series_basis not in SUPPORTED_SERIES_BASES:
+        return False
+    dates = asset.get("dates")
+    values = asset_values(asset)
+    if not isinstance(dates, list) or not isinstance(values, list) or len(dates) != len(values):
+        return False
+    if not dates:
+        return False
+    annualization_factor = asset.get("annualizationFactor")
+    if (
+        isinstance(annualization_factor, bool)
+        or not isinstance(annualization_factor, (int, float))
+        or not math.isfinite(annualization_factor)
+        or annualization_factor <= 0
+    ):
+        return False
+    previous = None
+    for current_date, value in zip(dates, values):
+        if not is_valid_civil_date(current_date):
+            return False
+        if previous is not None and current_date <= previous:
+            return False
+        if isinstance(value, bool) or not isinstance(value, (int, float)) or not math.isfinite(value) or value <= 0:
+            return False
+        previous = current_date
+    return True
+def check_methodology(asset_a: dict[str, Any], asset_b: dict[str, Any]) -> bool:
+    return (
+        asset_a.get("schemaVersion") == ARTIFACT_SCHEMA_VERSION
+        and asset_b.get("schemaVersion") == ARTIFACT_SCHEMA_VERSION
+        and asset_a.get("methodologyVersion") == METHODOLOGY_VERSION
+        and asset_b.get("methodologyVersion") == METHODOLOGY_VERSION
+        and asset_a.get("seriesBasis") in SUPPORTED_SERIES_BASES
+        and asset_b.get("seriesBasis") in SUPPORTED_SERIES_BASES
+    )
+def date_to_index(asset: dict[str, Any]) -> dict[str, int]:
+    return {current_date: index for index, current_date in enumerate(asset["dates"])}
+def native_window(asset: dict[str, Any], effective_start: str, effective_end: str) -> tuple[list[str], list[float]]:
+    dates: list[str] = []
+    values: list[float] = []
+    for current_date, value in zip(asset["dates"], asset_values(asset)):
+        if effective_start <= current_date <= effective_end:
+            dates.append(current_date)
+            values.append(float(value))
+    return dates, values
+def asset_metrics(asset: dict[str, Any], dates: list[str], values: list[float], amount_cents: int, elapsed_days: int) -> dict[str, Any]:
+    amount_usd = amount_cents / 100
+    growth = values[-1] / values[0]
+    ending_value_usd = amount_usd * growth
+    ending_value_cents = display_cents(ending_value_usd)
+    profit_loss_usd = ending_value_usd - amount_usd
+    profit_loss_cents = ending_value_cents - amount_cents
+    total_return = growth - 1
+    returns = simple_returns(values)
+    drawdown = drawdown_stats(values, dates)
+    cagr = metric_unavailable("period_too_short")
+    if elapsed_days >= 30:
+        cagr_value = growth ** (CAGR_DAY_COUNT / elapsed_days) - 1
+        cagr = metric_available(cagr_value, {"displayBasisPoints": display_basis_points(cagr_value)})
+    volatility = metric_unavailable("insufficient_data")
+    if len(returns) >= 30:
+        stddev = sample_stddev(returns)
+        if stddev is not None:
+            volatility_value = stddev * math.sqrt(float(asset.get("annualizationFactor", 252)))
+            volatility = metric_available(volatility_value, {"displayBasisPoints": display_basis_points(volatility_value)})
+    calmar = metric_unavailable("period_too_short")
+    drawdown_metric = drawdown["maxDrawdown"]
+    first_anniversary_reached = dates[-1] >= first_anniversary(dates[0])
+    if first_anniversary_reached and cagr["available"] and drawdown_metric["available"]:
+        max_drawdown = drawdown_metric["value"]
+        if abs(max_drawdown) >= CALMAR_MIN_ABS_DRAWDOWN:
+            calmar_value = cagr["value"] / abs(max_drawdown)
+            calmar = metric_available(calmar_value, {"displayHundredths": display_hundredths(calmar_value)})
+        else:
+            calmar = metric_unavailable("zero_drawdown")
+    return {
+        "endingValueUsd": normalize_zero(ending_value_usd),
+        "endingValueCents": ending_value_cents,
+        "profitLossUsd": normalize_zero(profit_loss_usd),
+        "profitLossCents": profit_loss_cents,
+        "totalReturn": metric_available(total_return, {"displayBasisPoints": display_basis_points(total_return)}),
+        "cagr": cagr,
+        "volatility": volatility,
+        "drawdown": drawdown,
+        "calmar": calmar,
+        "nativeObservationCount": len(values),
+        "nativeReturnCount": len(returns),
+        "periodOutcome": "gain" if profit_loss_cents > 0 else "loss" if profit_loss_cents < 0 else "unchanged",
+    }
+def compare_display_values(metric_a: dict[str, Any], metric_b: dict[str, Any], display_key: str) -> str:
+    if not metric_a.get("available") or not metric_b.get("available"):
+        return "unavailable"
+    value_a = metric_a[display_key]
+    value_b = metric_b[display_key]
+    if value_a == value_b:
+        return "tie"
+    return "asset_a" if value_a > value_b else "asset_b"
+def compare_ending_value(metrics_a: dict[str, Any], metrics_b: dict[str, Any]) -> str:
+    value_a = metrics_a["endingValueCents"]
+    value_b = metrics_b["endingValueCents"]
+    if value_a == value_b:
+        return "tie"
+    return "asset_a" if value_a > value_b else "asset_b"
+def compare_deeper_drawdown(metrics_a: dict[str, Any], metrics_b: dict[str, Any]) -> str:
+    drawdown_a = metrics_a["drawdown"]["maxDrawdown"]
+    drawdown_b = metrics_b["drawdown"]["maxDrawdown"]
+    if not drawdown_a.get("available") or not drawdown_b.get("available"):
+        return "unavailable"
+    value_a = drawdown_a["displayBasisPoints"]
+    value_b = drawdown_b["displayBasisPoints"]
+    if value_a == value_b:
+        return "tie"
+    return "asset_a" if value_a < value_b else "asset_b"
+def calculate_scenario(input_payload: dict[str, Any]) -> dict[str, Any]:
+    if not isinstance(input_payload, dict):
+        raise ValueError("invalid scenario input")
+    asset_a = input_payload.get("assetA")
+    asset_b = input_payload.get("assetB")
+    amount_cents = input_payload.get("amountCents")
+    requested_start = input_payload.get("requestedStart")
+    requested_end = input_payload.get("requestedEnd")
+    if not isinstance(asset_a, dict) or not isinstance(asset_b, dict):
+        raise ValueError("invalid asset artifact")
+    asset_key_a = asset_a.get("assetKey")
+    asset_key_b = asset_b.get("assetKey")
+    if not isinstance(asset_key_a, str) or not asset_key_a or not isinstance(asset_key_b, str) or not asset_key_b:
+        raise ValueError("invalid asset artifact")
+    if asset_key_a == asset_key_b:
+        return {"status": "error", "reason": "same_asset"}
+    if isinstance(amount_cents, bool) or not isinstance(amount_cents, int) or amount_cents < MIN_AMOUNT_CENTS or amount_cents > MAX_AMOUNT_CENTS:
+        return {"status": "error", "reason": "invalid_amount"}
+    if not is_valid_civil_date(requested_start) or not is_valid_civil_date(requested_end):
+        return {"status": "error", "reason": "invalid_date"}
+    if requested_start > requested_end:
+        return {"status": "error", "reason": "start_after_end"}
+    if not check_methodology(asset_a, asset_b):
+        return {"status": "error", "reason": "methodology_mismatch"}
+    if not validate_asset(asset_a) or not validate_asset(asset_b):
+        raise ValueError("invalid asset artifact")
+    index_a = date_to_index(asset_a)
+    index_b = date_to_index(asset_b)
+    shared_dates = [current_date for current_date in asset_a["dates"] if current_date in index_b]
+    if not shared_dates:
+        return {"status": "error", "reason": "no_overlap"}
+    requested_shared_dates = [current_date for current_date in shared_dates if requested_start <= current_date <= requested_end]
+    if not requested_shared_dates:
+        return {"status": "error", "reason": "no_overlap"}
+    effective_start = next((current_date for current_date in shared_dates if current_date >= requested_start), None)
+    effective_end = next((current_date for current_date in reversed(shared_dates) if current_date <= requested_end), None)
+    if effective_start is None or effective_end is None or effective_start >= effective_end:
+        return {"status": "error", "reason": "insufficient_shared_observations"}
+    selected_shared_dates = [current_date for current_date in shared_dates if effective_start <= current_date <= effective_end]
+    if len(selected_shared_dates) < 2:
+        return {"status": "error", "reason": "insufficient_shared_observations"}
+    elapsed_days = civil_day(effective_end) - civil_day(effective_start)
+    if elapsed_days <= 0:
+        return {"status": "error", "reason": "insufficient_shared_observations"}
+    native_dates_a, native_values_a = native_window(asset_a, effective_start, effective_end)
+    native_dates_b, native_values_b = native_window(asset_b, effective_start, effective_end)
+    values_a = asset_values(asset_a)
+    values_b = asset_values(asset_b)
+    shared_values_a = [float(values_a[index_a[current_date]]) for current_date in selected_shared_dates]
+    shared_values_b = [float(values_b[index_b[current_date]]) for current_date in selected_shared_dates]
+    metrics_a = asset_metrics(asset_a, native_dates_a, native_values_a, amount_cents, elapsed_days)
+    metrics_b = asset_metrics(asset_b, native_dates_b, native_values_b, amount_cents, elapsed_days)
+    shared_returns_a = simple_returns(shared_values_a)
+    shared_returns_b = simple_returns(shared_values_b)
+    correlation = (
+        pearson_correlation(shared_returns_a, shared_returns_b)
+        if len(shared_returns_a) >= 30 and len(shared_returns_b) >= 30
+        else metric_unavailable("insufficient_data")
+    )
+    amount_usd = amount_cents / 100
+    return {
+        "status": "ok",
+        "scenario": {
+            "methodologyVersion": METHODOLOGY_VERSION,
+            "methodologyContractHash": METHODOLOGY_HASH,
+            "amountCents": amount_cents,
+            "requestedStart": requested_start,
+            "requestedEnd": requested_end,
+            "effectiveStart": effective_start,
+            "effectiveEnd": effective_end,
+            "startSnap": "exact" if effective_start == requested_start else "forward",
+            "endSnap": "exact" if effective_end == requested_end else "backward",
+            "elapsedDays": elapsed_days,
+            "sharedObservationCount": len(selected_shared_dates),
+            "assetA": metrics_a,
+            "assetB": metrics_b,
+            "pair": {
+                "correlation": correlation,
+                "sharedReturnCount": len(shared_returns_a),
+            },
+            "wealthPath": [
+                {
+                    "date": current_date,
+                    "assetAUsd": normalize_zero(amount_usd * float(values_a[index_a[current_date]]) / shared_values_a[0]),
+                    "assetBUsd": normalize_zero(amount_usd * float(values_b[index_b[current_date]]) / shared_values_b[0]),
+                }
+                for current_date in selected_shared_dates
+            ],
+            "endingValueWinner": compare_ending_value(metrics_a, metrics_b),
+            "totalReturnWinner": compare_display_values(metrics_a["totalReturn"], metrics_b["totalReturn"], "displayBasisPoints"),
+            "deeperDrawdownAsset": compare_deeper_drawdown(metrics_a, metrics_b),
+        },
+    }

return_scenario_engine-0.1.0/return_scenario_engine/methodology/__init__.py ADDED Viewed

	@@ -0,0 +1 @@
1	+ """Versioned methodology documents bundled with the Python distribution."""

return_scenario_engine-0.1.0/return_scenario_engine/methodology/return-scenario-v1.json ADDED Viewed

@@ -0,0 +1,42 @@
+{
+  "schemaVersion": 1,
+  "methodologyVersion": "return-scenario-v1.0.0",
+  "constants": {
+    "amountCentsMin": 100,
+    "amountCentsMax": 1000000000,
+    "cagrDayCount": 365.25,
+    "calmarMinAbsDrawdown": 0.0001,
+    "defaultAnnualizationFactor": 252
+  },
+  "dateAlignment": {
+    "civilDatePattern": "YYYY-MM-DD",
+    "timezone": "utc_civil_day_ordinals",
+    "startSnap": "first_shared_on_or_after_request",
+    "endSnap": "last_shared_on_or_before_request",
+    "sharedMetrics": "shared_observation_dates_only",
+    "nativeMetrics": "per_asset_native_observations_between_shared_effective_boundaries"
+  },
+  "formulas": {
+    "totalReturn": "index_end/index_start-1",
+    "endingValueUsd": "amount_usd*index_end/index_start",
+    "cagr": "pow(index_end/index_start,365.25/elapsed_calendar_days)-1",
+    "realizedVolatility": "sample_stddev_native_simple_returns_ddof_1*sqrt(annualization_factor)",
+    "drawdown": "index_t/running_max(index_0_to_t)-1",
+    "calmar": "cagr/abs(max_drawdown)",
+    "correlation": "pearson_aligned_shared_simple_returns_ordered_centered_sums"
+  },
+  "minimumEvidence": {
+    "totalReturnSharedPrices": 2,
+    "cagrElapsedCalendarDays": 30,
+    "volatilityNativeReturns": 30,
+    "drawdownNativePrices": 2,
+    "correlationSharedReturns": 30,
+    "calmarFirstAnniversaryRequired": true
+  },
+  "rounding": {
+    "money": "integer_cents_half_away_from_zero",
+    "percent": "integer_basis_points_half_away_from_zero",
+    "ratio": "integer_hundredths_half_away_from_zero",
+    "negativeZero": "normalize_to_positive_zero"
+  }
+}

return_scenario_engine-0.1.0/return_scenario_engine.egg-info/PKG-INFO ADDED Viewed

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: return-scenario-engine
+Version: 0.1.0
+Summary: Portable historical return scenario calculations
+Author: Sid Kalla
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+           1. Definitions.
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+           END OF TERMS AND CONDITIONS
+           APPENDIX: How to apply the Apache License to your work.
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+           Copyright [yyyy] [name of copyright owner]
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+               http://www.apache.org/licenses/LICENSE-2.0
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+Project-URL: Homepage, https://github.com/sidko/return-scenario-engine
+Project-URL: Repository, https://github.com/sidko/return-scenario-engine
+Project-URL: Issues, https://github.com/sidko/return-scenario-engine/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: test
+Requires-Dist: build>=1.2; extra == "test"
+Dynamic: license-file
+# return-scenario-engine (Python)
+The Python distribution provides the same dependency-free normalized-index
+scenario API, methodology JSON, public SHA-256 hash, and synthetic golden corpus
+as the TypeScript package. Install with `python -m pip install
+return-scenario-engine`, then call `calculate_scenario` with explicit artifact
+dictionaries. Full contract, limits, examples, and security guidance are in the
+[repository README](https://github.com/sidko/return-scenario-engine#readme).
+```python
+from return_scenario_engine import calculate_scenario
+dates = ["2024-01-01", "2024-01-02", "2024-01-03"]
+base = {"schemaVersion": 1, "methodologyVersion": "return-scenario-v1.0.0", "seriesBasis": "close_index", "annualizationFactor": 365, "dates": dates}
+result = calculate_scenario({"amountCents": 100_000, "requestedStart": dates[0], "requestedEnd": dates[-1], "assetA": base | {"assetKey": "sample-a", "growthIndex": [100, 110, 121]}, "assetB": base | {"assetKey": "sample-b", "growthIndex": [100, 95, 100]}})
+assert result["status"] == "ok"
+```

return_scenario_engine-0.1.0/return_scenario_engine.egg-info/SOURCES.txt ADDED Viewed

@@ -0,0 +1,12 @@
+LICENSE
+NOTICE
+README.md
+pyproject.toml
+return_scenario_engine/__init__.py
+return_scenario_engine.egg-info/PKG-INFO
+return_scenario_engine.egg-info/SOURCES.txt
+return_scenario_engine.egg-info/dependency_links.txt
+return_scenario_engine.egg-info/requires.txt
+return_scenario_engine.egg-info/top_level.txt
+return_scenario_engine/methodology/__init__.py
+return_scenario_engine/methodology/return-scenario-v1.json

return_scenario_engine-0.1.0/return_scenario_engine.egg-info/dependency_links.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+

return_scenario_engine-0.1.0/return_scenario_engine.egg-info/requires.txt ADDED Viewed

@@ -0,0 +1,3 @@
+[test]
+build>=1.2

return_scenario_engine-0.1.0/return_scenario_engine.egg-info/top_level.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ return_scenario_engine

return_scenario_engine-0.1.0/setup.cfg ADDED Viewed

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build =
+tag_date = 0