Merge pull request #25 from actuarialopensource/update-pandas-dep

Update pandas dep

.devcontainer/devcontainer.json

@@ -1,12 +1,14 @@
 {
 	"name": "Python 3",
-	"image": "mcr.microsoft.com/devcontainers/python:3.7",
+	"image": "mcr.microsoft.com/devcontainers/python:3.9",
 	"features": {
-		"ghcr.io/devcontainers/features/node:1": {
-			"version": "none"
-		},
-		"ghcr.io/devcontainers/features/docker-in-docker:1": {},
-		"ghcr.io/dhoeric/features/act:1": {}
+		"ghcr.io/devcontainers/features/node:1": {},
+		"ghcr.io/devcontainers/features/docker-in-docker:2.10.1": {},
+		"ghcr.io/dhoeric/features/act:1": {},
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {},
+		"ghcr.io/meaningful-ooo/devcontainer-features/fish:1": {},
+		"ghcr.io/devcontainers-contrib/features/poetry:2": {},
+		"ghcr.io/stuartleeks/dev-container-features/shell-history:0": {}
 	}
 
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.

.github/workflows/pytest.yml

@@ -9,11 +9,11 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.7.1"
+          python-version: "3.9"
       - name: Install poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: 1.1.15
+          poetry-version: 1.8.2
       - name: Install requirements
         run: poetry install
       - name: Install requirements

README.md

@@ -15,7 +15,12 @@ If you want the full details of **any** SOA table, you can use the lower level `
 ```py
 from pymort import MortXML
 # load the 2017 Loaded CSO Composite Gender-Blended 20% Male ALB table (tableId = 3282)
-xml = MortXML(3282)
+xml = MortXML.from_id(3282)
+# you can load from a file path on your computer
+xml_from_path = MortXML.from_path("t3282.xml")
+# you can load from raw xml text
+xml_str = Path("t3282.xml").read_text()
+xml_from_str = MortXML(xml_str)
 ```
 
 This `MortXML` class is a wrapper around the [underlying XML](https://mort.soa.org/About.aspx). The autocompletions you get on attributes improve the developer experience over using the underlying XML directly.
@@ -34,7 +39,7 @@ For a select and ultimate table we can retrieve rates as follows.
 ```py
 from pymort import MortXML
 # Table 3265 is 2015 VBT Smoker Distinct Male Non-Smoker ANB, see https://mort.soa.org/ 
-xml = MortXML(3265)
+xml = MortXML.from_id(3265)
 # This is the select table as a MultiIndex (age/duration) DataFrame.
 xml.Tables[0].Values
 # This is the minimum value of the issue age axis on the select table
@@ -48,8 +53,8 @@ xml.Tables[1].Values
 We can get the data from Pandas to NumPy.
 
 ```py
-select = MortXML(3265).Tables[0].Values.unstack().values
-ultimate = MortXML(3265).Tables[1].Values.unstack().values
+select = MortXML.from_id(3265).Tables[0].Values.unstack().values
+ultimate = MortXML.from_id(3265).Tables[1].Values.unstack().values
 
 select.shape # (78, 25) ages from 18 to 95, duration from 1 to 25
 ultimate.shape # (103,) is age 18 to 120

pymort/XML.py

@@ -1,9 +1,10 @@
 from dataclasses import dataclass
 import pandas as pd
 import xml.etree.ElementTree as ET
-from typing import List
+from typing import List, Union
 import importlib.resources
-from . import archive_2022_May_04_093934 as data
+from os import PathLike
+from . import table_xml as data
 
 # The following classes represent the xml elements in the XTbML file https://mort.soa.org/About.aspx
 
@@ -75,19 +76,39 @@ class MortXML:
 
     """
 
-    def __init__(self, id: int):
+    def __init__(self, xml_str: str):
         """
         Takes the id of a table and returns the PyXML object.
 
         Args:
             id (int): The id of the table to be loaded.
         """
-        root = ET.fromstring(importlib.resources.read_text(data, f"t{id}.xml"))
+        root = ET.fromstring(xml_str)
         self.ContentClassification: ContentClassification = createContentClassification(
             root.find("./ContentClassification")
         )
         self.Tables: List[Table] = createTables(root)
 
+    @classmethod
+    def from_id(cls, id: int):
+        """
+        Takes an xml string and returns the PyXML object.
+
+        Args:
+            xml (str): The xml string to be loaded.
+        """
+        return cls(importlib.resources.read_text(data, f"t{id}.xml"))
+
+    @classmethod
+    def from_path(cls, xml_path: Union[str, bytes, PathLike]):
+        """
+        Takes an xml string and returns the PyXML object.
+
+        Args:
+            xml (str): The xml string to be loaded.
+        """
+        return cls(open(xml_path).read())
+
 
 # The following functions turn XML elements into Python objects.
 

pymort/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "1.0.0"
+__version__ = "2.0.1"
 
 from .XML import MortXML as MortXML