canvas 0.57.1__py3-none-any.whl → 0.58.1__py3-none-any.whl

{canvas-0.57.1.dist-info → canvas-0.58.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvas
-Version: 0.57.1
+Version: 0.58.1
 Summary: SDK to customize event-driven actions in your Canvas instance
 Author-email: Canvas Team <engineering@canvasmedical.com>
 License-Expression: MIT
@@ -13,6 +13,7 @@ Requires-Dist: django-stubs[compatible-mypy]<6,>=5.1.1
 Requires-Dist: django-timezone-utils<0.16,>=0.15.0
 Requires-Dist: django<6,>=5.1.1
 Requires-Dist: env-tools<3,>=2.4.0
+Requires-Dist: factory-boy>=3.3.3
 Requires-Dist: frozendict>=2.4.6
 Requires-Dist: grpcio<2,>=1.60.1
 Requires-Dist: ipython<9,>=8.21.0
@@ -32,6 +33,8 @@ Requires-Dist: statsd<5,>=4.0.1
 Requires-Dist: typer
 Requires-Dist: typing-extensions<4.13,>=4.8
 Requires-Dist: websocket-client<2,>=1.7.0
+Provides-Extra: test-utils
+Requires-Dist: pytest-canvas; extra == 'test-utils'
 Description-Content-Type: text/markdown
 
 [![codecov](https://codecov.io/gh/canvas-medical/canvas-plugins/graph/badge.svg?token=P8JJUOJ8FH)](https://codecov.io/gh/canvas-medical/canvas-plugins)

{canvas-0.57.1.dist-info → canvas-0.58.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-settings.py,sha256=Yu4LE0PcohXgxqO8-W0b5uoXMJ20p-NpUj1lNFCdB8I,6296
+settings.py,sha256=8CGtEpfAZ43FM6XPNJ8CgGwhWU9xn5mmncD7HZWi-Vk,6321
 canvas_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_cli/main.py,sha256=INnlb8THwC0kbUJY94FVFq4UtDRGRyBBm6jASTzV0mU,3111
 canvas_cli/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -70,18 +70,7 @@ canvas_cli/apps/logs/logs.py,sha256=BFpZ-2OF2Rs1EMLePo5UjqC9fKQeqm8qZobNTFNCL_M,
 canvas_cli/apps/plugin/__init__.py,sha256=GB6hBwbajm5cOs-DbJh3q6smPfAaIMa99tSbkvDtbqs,341
 canvas_cli/apps/plugin/plugin.py,sha256=vlnd61nPt98NnYUPAeZMogcRPgv1pdDqBtey13H_Tug,20817
 canvas_cli/apps/run_plugins/__init__.py,sha256=iAMgX_6D3CdjQodGx_azwhSjouaxquOm8Z8QVXnlTFE,117
-canvas_cli/apps/run_plugins/run_plugins.py,sha256=w4JTsXFiHckZahvbSOJAqZo3jWwedxlHLiXct1j_6cY,392
-canvas_cli/templates/plugins/application/cookiecutter.json,sha256=cI4Wpj68TkKeBP3P16PrjKacTHzsTIpl_rDdzyUpwz4,129
-canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/CANVAS_MANIFEST.json,sha256=-mfqhpljpF4eE8g05pIEnZMt_bDUdhgIBtuQd-devv8,945
-canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/README.md,sha256=3QKoJQq3YmdplGnDOBMsLCJ3Ya1_aKjoz-QiWc4QfjA,291
-canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/applications/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/applications/my_application.py,sha256=rTUUycVOZEj5B4CoBqWMl9T4xPIyTqxsWGzXfAd6huY,584
-canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/assets/python-logo.png,sha256=QAipNLQVwVK_pRO-PpsF3kISrkFUmifyxsjUGzokpNo,20637
-canvas_cli/templates/plugins/default/cookiecutter.json,sha256=dWEB3wJ8U4bko8jX26PgLLg_jgWlafLTNqsGnY1PUcg,124
-canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/CANVAS_MANIFEST.json,sha256=3a5PsKPZcENxRd0FYG9AnXNOKlpzP-hQua4HohIL3v0,638
-canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/README.md,sha256=3QKoJQq3YmdplGnDOBMsLCJ3Ya1_aKjoz-QiWc4QfjA,291
-canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/protocols/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/protocols/my_protocol.py,sha256=fKLLcOIwvSWenW8-7tr8VqnF4Iox_5wU9V-Qw9UySsA,2381
+canvas_cli/apps/run_plugins/run_plugins.py,sha256=5JbO0l4f2xtJbSTomJgKUqj416sT9GcDF0TrDg2JZYQ,3275
 canvas_cli/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_cli/utils/context/__init__.py,sha256=HhYvI-hydP0mV18nJiU7uo5gk0yN7EYNgouxieoGDOE,102
 canvas_cli/utils/context/context.py,sha256=wk4TxlslF52uD9nXcEZ1eY8L1rcEHk7k-6YBVwaWnVY,5191
@@ -223,6 +212,10 @@ canvas_sdk/questionnaires/__init__.py,sha256=Pe3R-RY70AOllljO_caNAPpHpJfA3ML5zmw
 canvas_sdk/questionnaires/utils.py,sha256=avDMUcQ5XmLfhlBpPJNMtNrVqrPy7g7HtqbSzztuIeQ,3666
 canvas_sdk/templates/__init__.py,sha256=LtUmLDsGSTq249T6sA7PUzkl2OfCAyvtIOGPNHr6wTo,83
 canvas_sdk/templates/utils.py,sha256=J-wDQ9ijOr_jz1SJxjpyZgR7JwXqtGMSS5IperLi2qE,1475
+canvas_sdk/test_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas_sdk/test_utils/factories/__init__.py,sha256=mtd247ZUaW3-w5RfuXGMC2iM8XYLnxXUIzbDWqSvo7o,171
+canvas_sdk/test_utils/factories/patient.py,sha256=KKHUcgqu3r3sOc21gQ5p__71zBLm9QZysW5TSnJ631U,1138
+canvas_sdk/test_utils/factories/user.py,sha256=QLxilvK22fHSsGFxe1j354VdMrdquO8nyWApdXXdS8Q,306
 canvas_sdk/utils/__init__.py,sha256=PADveJMf-BtOapK5Cczy-nOuZzVh-HT2H6sfJW_SK9U,198
 canvas_sdk/utils/db.py,sha256=wOZORBfyBVxQkay5vyEtQ4i0KVCfASFGREmecHMR8DE,409
 canvas_sdk/utils/http.py,sha256=BUpDcc8s_MVViiM9Y3FOAMZWW8bj2a8zIuQCl8bXt_s,10729
@@ -261,7 +254,7 @@ canvas_sdk/v1/data/message.py,sha256=EKc2kkWGuzrgBH3sDUa9jiNpRP7J1ZdWE6BnPhY2gvs
 canvas_sdk/v1/data/note.py,sha256=ZZN0CoQbXmXxzo1cb7bpiXBcy7kLpTzZueGgdd6H95Q,9301
 canvas_sdk/v1/data/observation.py,sha256=l1EXGQ8FBBInxQthsmY1Oms9v73ni_J7SAP5M8Hmkvg,3881
 canvas_sdk/v1/data/organization.py,sha256=gt0KZC1hklwWf57vCxs2K0qPnLpMyyNFWNL7-WZ6AqI,1159
-canvas_sdk/v1/data/patient.py,sha256=2leEjD8tDJD4AgSXl8rtEimyKMoSxgaqqKRqTXKz11w,9405
+canvas_sdk/v1/data/patient.py,sha256=7D_bxeCAoA_I8-2ZLzAMkCrV9ziZ_-IND9uOq0Wp83I,10515
 canvas_sdk/v1/data/patient_consent.py,sha256=zx1C__E6On-MC7OnTgEeP50tn77R6UXw15wC125jDog,2704
 canvas_sdk/v1/data/payment_collection.py,sha256=h17qmQkCCwSdukIeeYMqBHZnpxpahOa03ckMHmgZV-I,954
 canvas_sdk/v1/data/payor_specific_charge.py,sha256=TtByy7-QF00PfONC-QDo2kkxRAOdLaRjkhssQBPvZjw,770
@@ -275,8 +268,8 @@ canvas_sdk/v1/data/service_provider.py,sha256=LQfQ0esg97NpmSYnftsWqYUJyJIQOZKmpZ
 canvas_sdk/v1/data/staff.py,sha256=iVqBXwANp1qYEL39DIpveKbuqd1nw1oSDQ917xw8xgk,8302
 canvas_sdk/v1/data/task.py,sha256=9jSqr7e7ODJTs4hanWsOD-1Rb8gByJOuLta90V9V_hY,3480
 canvas_sdk/v1/data/team.py,sha256=J4s98sS7UuUw9jJCe-_7eikr1dV4SQARDzK5oxmsO_o,2832
-canvas_sdk/v1/data/user.py,sha256=14_yDFXQ38DF7quZLY5pXmL90_0wfYUTZvEkfKEAgAY,477
-canvas_sdk/v1/data/utils.py,sha256=r9eXGD-mxGhTmHaGEn_ap_QTE6vH1H4SFOdkb9wZNzM,392
+canvas_sdk/v1/data/user.py,sha256=82jnqVrYeWo2eBXY_MH2r75LZo5EKgY9kalahrUl0_s,511
+canvas_sdk/v1/data/utils.py,sha256=t_Q2wpTnvJBx3AJeGD_7ymLNQG63J3E3LU5uq_O99bQ,899
 canvas_sdk/value_set/__init__.py,sha256=YYXr5tEQlnwMgTXJbOG963tKSPiUOM4mUkX8wuiqp7U,17
 canvas_sdk/value_set/custom.py,sha256=smf5fnPwuW-7H_B49CUfLWnq1QH-PhItvYw0siVsu-o,20173
 canvas_sdk/value_set/hcc2018.py,sha256=MMudhqOOgvedh8-dDfC_JbHJn-sNRbk8Q357agD_Pww,2198496
@@ -317,7 +310,21 @@ protobufs/canvas_generated/messages/plugins.proto,sha256=xJyEeTwM6wWja3vGECLsIzf
 protobufs/canvas_generated/services/plugin_runner.proto,sha256=PZ0Ts11b9tdA5Gkg2M05JVEKAm0R4LFEwrGRS-TQ16E,466
 pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pubsub/pubsub.py,sha256=PHIvJ5SD3M-jQSYeGGSj1FuG6CvP6BQffAoGax9Uudk,1423
-canvas-0.57.1.dist-info/METADATA,sha256=MPYJjyR4mKewN9sbDrqzm3N0WSDY1ZY47gIRtCpqUbE,4645
-canvas-0.57.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-canvas-0.57.1.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
-canvas-0.57.1.dist-info/RECORD,,
+canvas_cli/templates/plugins/application/cookiecutter.json,sha256=cI4Wpj68TkKeBP3P16PrjKacTHzsTIpl_rDdzyUpwz4,129
+canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/CANVAS_MANIFEST.json,sha256=-mfqhpljpF4eE8g05pIEnZMt_bDUdhgIBtuQd-devv8,945
+canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/README.md,sha256=3QKoJQq3YmdplGnDOBMsLCJ3Ya1_aKjoz-QiWc4QfjA,291
+canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/applications/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/applications/my_application.py,sha256=rTUUycVOZEj5B4CoBqWMl9T4xPIyTqxsWGzXfAd6huY,584
+canvas_cli/templates/plugins/application/{{ cookiecutter.__project_slug }}/assets/python-logo.png,sha256=QAipNLQVwVK_pRO-PpsF3kISrkFUmifyxsjUGzokpNo,20637
+canvas_cli/templates/plugins/default/cookiecutter.json,sha256=LbcuMaWxrLats1BffuDkk2192qNTgA-NU6sAnsFyj8M,201
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/pyproject.toml,sha256=ogQ94GnE-Aj2KJbiTevwnomqKdZUeBZfIOTcU_KPPdI,422
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/tests/test_models.py,sha256=IWe3IarNQuS350owh87X1qi-PcpaxzBBNCStr8LC3Co,980
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/{{ cookiecutter.__package_name }}/CANVAS_MANIFEST.json,sha256=1keK1aJ-rJu4hm5ypqJT82hooCUTUOQ10dhzQ-mab7c,638
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/{{ cookiecutter.__package_name }}/README.md,sha256=3QKoJQq3YmdplGnDOBMsLCJ3Ya1_aKjoz-QiWc4QfjA,291
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/{{ cookiecutter.__package_name }}/protocols/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/{{ cookiecutter.__package_name }}/protocols/my_protocol.py,sha256=fKLLcOIwvSWenW8-7tr8VqnF4Iox_5wU9V-Qw9UySsA,2381
+canvas-0.58.1.dist-info/METADATA,sha256=3X9kEv7rwoBL0FHJVrtoGNhJYPYU_lojLmyJxgVY6n0,4758
+canvas-0.58.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+canvas-0.58.1.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
+canvas-0.58.1.dist-info/RECORD,,

canvas_cli/apps/run_plugins/run_plugins.py

@@ -1,16 +1,102 @@
+from collections.abc import Generator
+from contextlib import contextmanager
+from pathlib import Path
+
+import django.db
+import typer
+from django.core.management import call_command
+
+import settings
 from plugin_runner.plugin_runner import main as run_server
 
 
-def run_plugin(plugin_directory: str) -> None:
+@contextmanager
+def _patch_default_db_connection() -> Generator[None, None, None]:
+    """
+    Temporarily patch the 'default' Django DB connection to allow db writes.
+    """
+    original_default = django.db.connections["default"]
+    try:
+        temp_handler = django.db.utils.ConnectionHandler(
+            {"default": settings.SQLITE_WRITE_MODE_DATABASE}
+        )
+        django.db.connections["default"] = temp_handler["default"]
+        yield
+    finally:
+        django.db.connections["default"] = original_default
+
+
+def _run_db_seed_file(path: Path) -> None:
+    """Run the database setup file to initialize the database."""
+    code = path.read_text()
+    exec_globals = {"__name__": "__main__"}
+    exec(code, exec_globals)
+
+
+def _reset_db(seed_file: Path | None = None) -> None:
+    """Reset the database."""
+    settings.SQLITE_DB_PATH.unlink(missing_ok=True)
+
+    with _patch_default_db_connection():
+        call_command("migrate", run_syncdb=True, verbosity=0)
+        if seed_file:
+            _run_db_seed_file(seed_file)
+
+
+def run_plugin(
+    plugin_directory: str = typer.Argument(..., help="Path to the plugin directory to run."),
+    db_seed_file: Path | None = typer.Option(
+        help="Path to the database seed file to use.",
+        default=None,
+    ),
+    reset_db: bool = typer.Option(
+        help="Reset the database before running the plugin.", default=False
+    ),
+) -> None:
     """
     Run the specified plugin for local development.
     """
-    return run_plugins([plugin_directory])
+    _run_plugins([plugin_directory], db_seed_file=db_seed_file, reset_db=reset_db)
 
 
-def run_plugins(plugin_directories: list[str]) -> None:
+def run_plugins(
+    plugin_directories: list[str],
+    db_seed_file: Path | None = typer.Option(
+        help="Path to the database seed file to use.",
+        default=None,
+    ),
+    reset_db: bool = typer.Option(
+        help="Reset the database before running the plugin(s).", default=False
+    ),
+) -> None:
     """
     Run the specified plugins for local development.
     """
+    _run_plugins(plugin_directories, db_seed_file=db_seed_file, reset_db=reset_db)
+
+
+def _run_plugins(
+    plugin_directories: list[str], db_seed_file: Path | None = None, reset_db: bool = False
+) -> None:
+    """
+    Run the specified plugins for local development.
+    """
+    if db_seed_file:
+        if not db_seed_file.exists():
+            raise typer.BadParameter(f"Database setup file not found: {db_seed_file.resolve()}")
+        if not db_seed_file.is_file():
+            raise typer.BadParameter(
+                f"Database setup file is not a regular file: {db_seed_file.resolve()}"
+            )
+        if not db_seed_file.suffix == ".py":
+            raise typer.BadParameter("Database setup file must be a Python script (.py)")
+
+    if settings.CANVAS_SDK_DB_BACKEND != "sqlite3":
+        raise typer.BadParameter(
+            "Database backend must be 'sqlite3' for local plugin development. Please unset 'DATABASE_URL' env var."
+        )
+
+    if db_seed_file or reset_db:
+        _reset_db(seed_file=db_seed_file)
+
     run_server(plugin_directories)
-    return

canvas_cli/templates/plugins/default/cookiecutter.json

@@ -1,4 +1,5 @@
 {
     "project_name": "My Cool Plugin",
-    "__project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}"
+    "__project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
+    "__package_name": "{{ cookiecutter.__project_slug.replace('-', '_') }}"
 }

canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+authors = [
+  {email = "engineering@canvasmedical.com", name = "Canvas Team"}
+]
+dependencies = [
+  "canvas[test-utils]"
+]
+description = "Some description of your project."
+license = "MIT"
+name = "{{ cookiecutter.__project_slug }}"
+readme = "{{cookiecutter.__package_name }}/README.md"
+requires-python = ">=3.11"
+version = "0.1.0"
+
+[tool.pytest.ini_options]
+python_files = ["*_tests.py", "test_*.py", "tests.py"]

canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/tests/test_models.py

@@ -0,0 +1,21 @@
+# To run the tests, use the command `pytest` in the terminal or uv run pytest.
+# Each test is wrapped inside a transaction that is rolled back at the end of the test.
+# If you want to modify which files are used for testing, check the [tool.pytest.ini_options] section in pyproject.toml.
+
+
+from canvas_sdk.test_utils.factories import PatientFactory
+from canvas_sdk.v1.data.discount import Discount
+
+
+# You can use a factory to create a patient instance for testing purposes.
+def test_factory() -> None:
+    """Test that a patient can be created using the PatientFactory."""
+    patient = PatientFactory.create()
+    assert patient.id is not None
+
+
+# if a factory is not available, you can create an instance manually with the data model directly.
+def test_model() -> None:
+    """Test that a Discount instance can be created."""
+    Discount.objects.create(name="10%", adjustment_group="30", adjustment_code="CO", discount=0.10)
+    assert Discount.objects.first().pk is not None

canvas_cli/templates/plugins/default/{{ cookiecutter.__project_slug }}/{CANVAS_MANIFEST.json → {{ cookiecutter.__package_name }}/CANVAS_MANIFEST.json }

@@ -1,12 +1,12 @@
 {
     "sdk_version": "0.1.4",
     "plugin_version": "0.0.1",
-    "name": "{{ cookiecutter.__project_slug }}",
+    "name": "{{ cookiecutter.__package_name }}",
     "description": "Edit the description in CANVAS_MANIFEST.json",
     "components": {
         "protocols": [
             {
-                "class": "{{ cookiecutter.__project_slug }}.protocols.my_protocol:Protocol",
+                "class": "{{ cookiecutter.__package_name }}.protocols.my_protocol:Protocol",
                 "description": "A protocol that does xyz..."
             }
         ],

canvas_sdk/test_utils/factories/__init__.py

@@ -0,0 +1,4 @@
+from .patient import PatientAddressFactory, PatientFactory
+from .user import CanvasUserFactory
+
+__all__ = ("CanvasUserFactory", "PatientAddressFactory", "PatientFactory")

canvas_sdk/test_utils/factories/patient.py

@@ -0,0 +1,39 @@
+import datetime
+
+import factory
+from factory.fuzzy import FuzzyDate
+
+from canvas_sdk.test_utils.factories.user import CanvasUserFactory
+from canvas_sdk.v1.data import Patient, PatientAddress
+
+
+class PatientAddressFactory(factory.django.DjangoModelFactory[PatientAddress]):
+    """Factory for creating a PatientAddress."""
+
+    class Meta:
+        model = PatientAddress
+
+    line1 = "1234 Main Street"
+    line2 = "Apt 3"
+    city = "San Francisco"
+    district = "Sunset"
+    state_code = "CA"
+    postal_code = "94112"
+    country = "USA"
+
+
+class PatientFactory(factory.django.DjangoModelFactory[Patient]):
+    """Factory for creating a Patient."""
+
+    class Meta:
+        model = Patient
+
+    birth_date = FuzzyDate(
+        start_date=datetime.date.today() - datetime.timedelta(days=100 * 365),
+        end_date=datetime.date.today() - datetime.timedelta(days=10 * 365),
+    )
+    first_name = factory.Faker("first_name")
+    middle_name = factory.Faker("first_name")
+    last_name = factory.Faker("last_name")
+    addresses = factory.RelatedFactory(PatientAddressFactory, "patient")
+    user = factory.SubFactory(CanvasUserFactory)

canvas_sdk/test_utils/factories/user.py

@@ -0,0 +1,13 @@
+import factory
+
+from canvas_sdk.v1.data import CanvasUser
+
+
+class CanvasUserFactory(factory.django.DjangoModelFactory[CanvasUser]):
+    """Factory for creating a CanvasUser."""
+
+    class Meta:
+        model = CanvasUser
+
+    email = factory.Faker("email")
+    phone_number = factory.Faker("phone_number")

canvas_sdk/v1/data/patient.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 import arrow
 from django.contrib.postgres.fields import ArrayField
@@ -16,10 +16,7 @@ from canvas_sdk.v1.data.common import (
     ContactPointSystem,
     ContactPointUse,
 )
-from canvas_sdk.v1.data.utils import create_key
-
-if TYPE_CHECKING:
-    from django_stubs_ext.db.models.manager import RelatedManager
+from canvas_sdk.v1.data.utils import create_key, generate_mrn
 
 
 class SexAtBirth(TextChoices):
@@ -51,45 +48,65 @@ class Patient(Model):
     id = models.CharField(
         max_length=32, db_column="key", unique=True, editable=False, default=create_key
     )
-    first_name = models.CharField(max_length=255)
-    last_name = models.CharField(max_length=255)
+    first_name = models.CharField(max_length=255, default="", blank=True)
+    middle_name = models.CharField(max_length=255, default="", blank=True)
+    last_name = models.CharField(max_length=255, default="", blank=True)
+    maiden_name = models.CharField(max_length=255, default="", blank=True)
     birth_date = models.DateField()
     business_line = models.ForeignKey(
-        "v1.BusinessLine", on_delete=models.DO_NOTHING, related_name="patients"
+        "v1.BusinessLine",
+        on_delete=models.DO_NOTHING,
+        related_name="patients",
+        null=True,
     )
     sex_at_birth = models.CharField(choices=SexAtBirth.choices, max_length=3)
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-    prefix = models.CharField(max_length=100)
-    suffix = models.CharField(max_length=100)
-    middle_name = models.CharField(max_length=255)
-    maiden_name = models.CharField(max_length=255)
+
+    prefix = models.CharField(max_length=100, blank=True, default="")
+    suffix = models.CharField(max_length=100, blank=True, default="")
     nickname = models.CharField(max_length=255)
-    sexual_orientation_term = models.CharField(max_length=255)
-    sexual_orientation_code = models.CharField(max_length=255)
-    gender_identity_term = models.CharField(max_length=255)
-    gender_identity_code = models.CharField(max_length=255)
-    preferred_pronouns = models.CharField(max_length=255)
-    biological_race_codes = ArrayField(models.CharField(max_length=100))
-    last_known_timezone = models.CharField(max_length=32)
-    mrn = models.CharField(max_length=9)
-    active = models.BooleanField()
-    deceased = models.BooleanField()
-    deceased_datetime = models.DateTimeField()
-    deceased_cause = models.TextField()
-    deceased_comment = models.TextField()
-    other_gender_description = models.CharField(max_length=255)
-    social_security_number = models.CharField(max_length=9)
-    administrative_note = models.TextField()
-    clinical_note = models.TextField()
-    mothers_maiden_name = models.CharField(max_length=255)
-    multiple_birth_indicator = models.BooleanField()
-    birth_order = models.BigIntegerField()
-    default_location_id = models.BigIntegerField()
-    default_provider_id = models.BigIntegerField()
+    sexual_orientation_term = models.CharField(max_length=255, default="", blank=True)
+    sexual_orientation_code = models.CharField(max_length=255, default="", blank=True)
+    gender_identity_term = models.CharField(max_length=255, default="", blank=True)
+    gender_identity_code = models.CharField(max_length=255, default="", blank=True)
+    preferred_pronouns = models.CharField(max_length=255, default="", blank=True)
+    biological_race_codes = ArrayField(
+        models.CharField(max_length=100, default="", blank=True), default=list, blank=True
+    )
+    last_known_timezone = models.CharField(max_length=32, null=True, blank=True)
+    mrn = models.CharField(max_length=9, unique=True, default=generate_mrn)
+    active = models.BooleanField(default=True)
+    deceased = models.BooleanField(default=False)
+    deceased_datetime = models.DateTimeField(null=True, blank=True)
+    deceased_cause = models.TextField(default="", blank=True)
+    deceased_comment = models.TextField(default="", blank=True)
+    other_gender_description = models.CharField(max_length=255, blank=True, default="")
+    social_security_number = models.CharField(max_length=9, blank=True, default="")
+    administrative_note = models.TextField(null=True, blank=True)
+    clinical_note = models.TextField(default="", blank=True)
+    mothers_maiden_name = models.CharField(max_length=255, blank=True, default="")
+    multiple_birth_indicator = models.BooleanField(null=True, blank=True)
+    birth_order = models.BigIntegerField(null=True, blank=True)
+
+    default_location = models.ForeignKey(
+        "v1.PracticeLocation",
+        on_delete=models.SET_NULL,
+        default=None,
+        null=True,
+        blank=True,
+        related_name="default_patients",
+    )
+    default_provider = models.ForeignKey(
+        "v1.Staff",
+        on_delete=models.SET_NULL,
+        default=None,
+        null=True,
+        blank=True,
+        related_name="default_patients",
+    )
     user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
 
-    settings: RelatedManager[PatientSetting]
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
 
     @classmethod
     def find(cls, id: str) -> Patient:
@@ -179,20 +196,23 @@ class PatientAddress(IdentifiableModel):
     class Meta:
         db_table = "canvas_sdk_data_api_patientaddress_001"
 
-    line1 = models.CharField(max_length=255)
-    line2 = models.CharField(max_length=255)
+    line1 = models.CharField(max_length=255, default="", blank=True)
+    line2 = models.CharField(max_length=255, default="", blank=True)
     city = models.CharField(max_length=255)
-    district = models.CharField(max_length=255)
+    district = models.CharField(max_length=255, blank=True, default="")
     state_code = models.CharField(max_length=2)
     postal_code = models.CharField(max_length=255)
-    use = models.CharField(choices=AddressUse.choices, max_length=10)
-    type = models.CharField(choices=AddressType.choices, max_length=10)
-    longitude = models.FloatField()
-    latitude = models.FloatField()
-    start = models.DateField()
-    end = models.DateField()
+    use = models.CharField(choices=AddressUse.choices, max_length=10, default=AddressUse.HOME)
+    type = models.CharField(choices=AddressType.choices, max_length=10, default=AddressType.BOTH)
+    longitude = models.FloatField(null=True, blank=True)
+    latitude = models.FloatField(null=True, blank=True)
+    start = models.DateField(null=True, blank=True)
+    end = models.DateField(null=True, blank=True)
     country = models.CharField(max_length=255)
-    state = models.CharField(choices=AddressState.choices, max_length=20)
+    state = models.CharField(
+        choices=AddressState.choices, max_length=20, default=AddressState.ACTIVE
+    )
+
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="addresses", null=True
     )

canvas_sdk/v1/data/user.py

@@ -11,8 +11,8 @@ class CanvasUser(Model):
 
     email = models.EmailField(db_column="email")
     phone_number = models.CharField(db_column="phone_number", max_length=255)
-    last_invite_date_time = models.DateTimeField()
-    is_portal_registered = models.BooleanField()
+    last_invite_date_time = models.DateTimeField(null=True, blank=True)
+    is_portal_registered = models.BooleanField(default=False)
 
 
 __exports__ = ("CanvasUser",)

canvas_sdk/v1/data/utils.py

@@ -1,3 +1,5 @@
+import random
+import string
 import uuid
 from collections.abc import Sequence
 from decimal import Decimal
@@ -13,4 +15,18 @@ def create_key() -> str:
     return uuid.uuid4().hex
 
 
+def generate_mrn(length: int = 9, max_attempts: int = 100) -> str:
+    """Generates a unique Medical Record Number (MRN) of specified length."""
+    from canvas_sdk.v1.data import Patient
+
+    digits = string.digits
+
+    for _ in range(max_attempts):
+        mrn = "".join(random.choices(digits, k=length))
+        if not Patient.objects.filter(mrn=mrn).exists():
+            return mrn
+
+    raise RuntimeError(f"Unable to generate a unique MRN after {max_attempts} attempts")
+
+
 __exports__ = ()

settings.py

@@ -108,18 +108,21 @@ if CANVAS_SDK_DB_BACKEND == "postgres":
     DATABASES = {"default": db_config}
 
 elif CANVAS_SDK_DB_BACKEND == "sqlite3":
+    SQLITE_DB_PATH = BASE_DIR / "canvas_db.sqlite3"
+    SQLITE_WRITE_MODE_DATABASE = {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": str(SQLITE_DB_PATH),
+    }
+
     DATABASES = {
         "default": {
             "ENGINE": "django.db.backends.sqlite3",
-            "NAME": f"file:{str(BASE_DIR / 'db.sqlite3')}?mode=ro",
+            "NAME": f"file:{SQLITE_DB_PATH}?mode=ro",
             "OPTIONS": {"uri": True},
-        },
-        "default-write": {
-            "ENGINE": "django.db.backends.sqlite3",
-            "NAME": str(BASE_DIR / "db.sqlite3"),
-        },
+        }
     }
 
+
 else:
     raise ImproperlyConfigured(
         "Unsupported database backend specified in 'CANVAS_SDK_DB_BACKEND' setting. "