From 3b1ddb2bfdbf81d3efc4c1f3170f28be7912e69d Mon Sep 17 00:00:00 2001 From: Vignesh Hari Date: Sun, 31 Mar 2024 01:57:31 +0530 Subject: [PATCH 01/13] Add Plugin Support --- config/settings/base.py | 19 +++--- config/urls.py | 134 ++++++++++++++++++++-------------------- docker/dev.Dockerfile | 4 +- docker/prod.Dockerfile | 5 +- install_plugins.py | 3 + plug_config.py | 13 ++++ plugs/manager.py | 28 +++++++++ plugs/plug.py | 10 +++ 8 files changed, 139 insertions(+), 77 deletions(-) create mode 100644 install_plugins.py create mode 100644 plug_config.py create mode 100644 plugs/manager.py create mode 100644 plugs/plug.py diff --git a/config/settings/base.py b/config/settings/base.py index f87916098a..6925be27e7 100644 --- a/config/settings/base.py +++ b/config/settings/base.py @@ -14,6 +14,7 @@ from care.utils.csp import config as csp_config from care.utils.jwks.generate_jwk import generate_encoded_jwks +from plug_config import manager BASE_DIR = Path(__file__).resolve(strict=True).parent.parent.parent APPS_DIR = BASE_DIR / "care" @@ -58,7 +59,6 @@ DATABASES["default"]["CONN_MAX_AGE"] = env.int("CONN_MAX_AGE", default=0) DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" - REDIS_URL = env("REDIS_URL", default="redis://localhost:6379") # CACHES @@ -77,7 +77,6 @@ } } - # URLS # ------------------------------------------------------------------------------ # https://docs.djangoproject.com/en/dev/ref/settings/#root-urlconf @@ -119,8 +118,15 @@ "care.audit_log", "care.hcx", ] + +PLUGIN_APPS = manager.get_apps() + +# Plugin Section + +PLUGIN_CONFIGS = manager.get_config() + # https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps -INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS +INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS + PLUGIN_APPS # MIGRATIONS # ------------------------------------------------------------------------------ @@ -303,7 +309,7 @@ "formatters": { "verbose": { "format": "%(levelname)s %(asctime)s %(module)s " - "%(process)d %(thread)d %(message)s" + "%(process)d %(thread)d %(message)s" } }, "handlers": { @@ -387,7 +393,6 @@ # https://github.com/fabiocaccamo/django-maintenance-mode/tree/main#configuration-optional MAINTENANCE_MODE = int(env("MAINTENANCE_MODE", default="0")) - # Password Reset # ------------------------------------------------------------------------------ # https://github.com/anexia-it/django-rest-passwordreset#configuration--settings @@ -396,7 +401,6 @@ # https://github.com/anexia-it/django-rest-passwordreset#custom-email-lookup DJANGO_REST_LOOKUP_FIELD = "username" - # Hardcopy settings (pdf generation) # ------------------------------------------------------------------------------ # https://github.com/loftylabs/django-hardcopy#installation @@ -485,7 +489,6 @@ ) SEND_SMS_NOTIFICATION = False - # Cloud and Buckets # ------------------------------------------------------------------------------ @@ -567,7 +570,6 @@ else FACILITY_S3_BUCKET_ENDPOINT, ) - # for setting the shifting mode PEACETIME_MODE = env.bool("PEACETIME_MODE", default=True) @@ -603,7 +605,6 @@ X_CM_ID = env("X_CM_ID", default="sbx") FIDELIUS_URL = env("FIDELIUS_URL", default="http://fidelius:8090") - IS_PRODUCTION = False # HCX diff --git a/config/urls.py b/config/urls.py index 9b76c36bbf..00bd001bd7 100644 --- a/config/urls.py +++ b/config/urls.py @@ -28,76 +28,75 @@ ) from config import api_router from config.health_views import MiddlewareAuthenticationVerifyView - from .auth_views import AnnotatedTokenVerifyView, TokenObtainPairView, TokenRefreshView from .views import home_view, ping urlpatterns = [ - path("", home_view, name="home"), - path("ping/", ping, name="ping"), - # Django Admin, use {% url 'admin:index' %} - path(settings.ADMIN_URL, admin.site.urls), - # Rest API - path("api/v1/auth/login/", TokenObtainPairView.as_view(), name="token_obtain_pair"), - path( - "api/v1/auth/token/refresh/", TokenRefreshView.as_view(), name="token_refresh" - ), - path( - "api/v1/auth/token/verify/", - AnnotatedTokenVerifyView.as_view(), - name="token_verify", - ), - path( - "api/v1/password_reset/", - ResetPasswordRequestToken.as_view(), - name="password_reset_request", - ), - path( - "api/v1/password_reset/confirm/", - ResetPasswordConfirm.as_view(), - name="password_reset_confirm", - ), - path( - "api/v1/password_reset/check/", - ResetPasswordCheck.as_view(), - name="password_reset_check", - ), - path( - "api/v1/password_change/", - ChangePasswordView.as_view(), - name="change_password_view", - ), - path("api/v1/", include(api_router.urlpatterns)), - # Hcx Listeners - path( - "coverageeligibility/on_check", - CoverageElibilityOnCheckView.as_view(), - name="hcx_coverage_eligibility_on_check", - ), - path( - "preauth/on_submit", - PreAuthOnSubmitView.as_view(), - name="hcx_pre_auth_on_submit", - ), - path( - "claim/on_submit", - ClaimOnSubmitView.as_view(), - name="hcx_claim_on_submit", - ), - path( - "communication/request", - CommunicationRequestView.as_view(), - name="hcx_communication_on_request", - ), - # Health check urls - path("middleware/verify", MiddlewareAuthenticationVerifyView.as_view()), - path( - ".well-known/openid-configuration", - OpenIdConfigView.as_view(), - name="openid-configuration", - ), - path("health/", include("healthy_django.urls", namespace="healthy_django")), -] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) + path("", home_view, name="home"), + path("ping/", ping, name="ping"), + # Django Admin, use {% url 'admin:index' %} + path(settings.ADMIN_URL, admin.site.urls), + # Rest API + path("api/v1/auth/login/", TokenObtainPairView.as_view(), name="token_obtain_pair"), + path( + "api/v1/auth/token/refresh/", TokenRefreshView.as_view(), name="token_refresh" + ), + path( + "api/v1/auth/token/verify/", + AnnotatedTokenVerifyView.as_view(), + name="token_verify", + ), + path( + "api/v1/password_reset/", + ResetPasswordRequestToken.as_view(), + name="password_reset_request", + ), + path( + "api/v1/password_reset/confirm/", + ResetPasswordConfirm.as_view(), + name="password_reset_confirm", + ), + path( + "api/v1/password_reset/check/", + ResetPasswordCheck.as_view(), + name="password_reset_check", + ), + path( + "api/v1/password_change/", + ChangePasswordView.as_view(), + name="change_password_view", + ), + path("api/v1/", include(api_router.urlpatterns)), + # Hcx Listeners + path( + "coverageeligibility/on_check", + CoverageElibilityOnCheckView.as_view(), + name="hcx_coverage_eligibility_on_check", + ), + path( + "preauth/on_submit", + PreAuthOnSubmitView.as_view(), + name="hcx_pre_auth_on_submit", + ), + path( + "claim/on_submit", + ClaimOnSubmitView.as_view(), + name="hcx_claim_on_submit", + ), + path( + "communication/request", + CommunicationRequestView.as_view(), + name="hcx_communication_on_request", + ), + # Health check urls + path("middleware/verify", MiddlewareAuthenticationVerifyView.as_view()), + path( + ".well-known/openid-configuration", + OpenIdConfigView.as_view(), + name="openid-configuration", + ), + path("health/", include("healthy_django.urls", namespace="healthy_django")), + ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) if settings.ENABLE_ABDM: urlpatterns += abdm_urlpatterns @@ -143,3 +142,6 @@ ), path("redoc/", SpectacularRedocView.as_view(url_name="schema"), name="redoc"), ] + +for plug in settings.PLUGIN_APPS: + urlpatterns += [path(f"{plug}/", include(f"{plug}.urls"))] diff --git a/docker/dev.Dockerfile b/docker/dev.Dockerfile index f71f5f6464..945ffa03da 100644 --- a/docker/dev.Dockerfile +++ b/docker/dev.Dockerfile @@ -8,7 +8,7 @@ ENV PATH /venv/bin:$PATH RUN apt-get update && apt-get install --no-install-recommends -y \ build-essential libjpeg-dev zlib1g-dev \ - libpq-dev gettext wget curl gnupg chromium \ + libpq-dev gettext wget curl gnupg chromium git \ && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \ && rm -rf /var/lib/apt/lists/* @@ -21,6 +21,8 @@ RUN pipenv install --system --categories "packages dev-packages" COPY . /app +RUN python3 /app/install_plugins.py + HEALTHCHECK \ --interval=10s \ --timeout=5s \ diff --git a/docker/prod.Dockerfile b/docker/prod.Dockerfile index a6e7d8709b..ab6d548a73 100644 --- a/docker/prod.Dockerfile +++ b/docker/prod.Dockerfile @@ -14,7 +14,7 @@ ARG BUILD_ENVIRONMENT=production ENV PATH /venv/bin:$PATH RUN apt-get update && apt-get install --no-install-recommends -y \ - build-essential libjpeg-dev zlib1g-dev libpq-dev + build-essential libjpeg-dev zlib1g-dev libpq-dev git # use pipenv to manage virtualenv RUN python -m venv /venv @@ -23,6 +23,9 @@ RUN pip install pipenv COPY Pipfile Pipfile.lock ./ RUN pipenv sync --system --categories "packages" +COPY . /app + +RUN python3 /app/install_plugins.py # --- FROM base as runtime diff --git a/install_plugins.py b/install_plugins.py new file mode 100644 index 0000000000..8324ff795b --- /dev/null +++ b/install_plugins.py @@ -0,0 +1,3 @@ +from plug_config import manager + +manager.install() diff --git a/plug_config.py b/plug_config.py new file mode 100644 index 0000000000..9edad7cb48 --- /dev/null +++ b/plug_config.py @@ -0,0 +1,13 @@ +from plugs.manager import PlugManager +from plugs.plug import Plug + +scribe_plug = Plug( + name="care_scribe", + package_name="git+https://github.com/coronasafe/care_scribe.git", + version="@master", + configs={}, +) + +plugs = [scribe_plug] + +manager = PlugManager(plugs) diff --git a/plugs/manager.py b/plugs/manager.py new file mode 100644 index 0000000000..f080bb9570 --- /dev/null +++ b/plugs/manager.py @@ -0,0 +1,28 @@ +import subprocess +import sys +from collections import defaultdict + + +class PlugManager: + """ + Manager to manage plugs in care + """ + + def __init__(self, plugs): + self.plugs = plugs + + def install(self): + packages = [x.package_name + x.version for x in self.plugs] + subprocess.check_call( + [sys.executable, "-m", "pip", "install", " ".join(packages)] + ) + + def get_apps(self): + return [plug.name for plug in self.plugs] + + def get_config(self): + configs = defaultdict(dict) + for plug in self.plugs: + for key, value in plug.configs.items(): + configs[plug.name][key] = value + return configs diff --git a/plugs/plug.py b/plugs/plug.py new file mode 100644 index 0000000000..8a94b6a49a --- /dev/null +++ b/plugs/plug.py @@ -0,0 +1,10 @@ +class Plug: + """ + Abstraction of a plugin + """ + + def __init__(self, name, package_name, version, **configs): + self.name = name + self.package_name = package_name + self.version = version + self.configs = configs From db6f739a32310a6cc80e36d8c8395fdf01937aa0 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Sun, 31 Mar 2024 02:48:42 +0530 Subject: [PATCH 02/13] fix lint --- config/settings/base.py | 2 +- config/urls.py | 131 ++++++++++++++++++++-------------------- 2 files changed, 67 insertions(+), 66 deletions(-) diff --git a/config/settings/base.py b/config/settings/base.py index 6925be27e7..9a6df3249b 100644 --- a/config/settings/base.py +++ b/config/settings/base.py @@ -309,7 +309,7 @@ "formatters": { "verbose": { "format": "%(levelname)s %(asctime)s %(module)s " - "%(process)d %(thread)d %(message)s" + "%(process)d %(thread)d %(message)s" } }, "handlers": { diff --git a/config/urls.py b/config/urls.py index 00bd001bd7..f19b0603e7 100644 --- a/config/urls.py +++ b/config/urls.py @@ -28,75 +28,76 @@ ) from config import api_router from config.health_views import MiddlewareAuthenticationVerifyView + from .auth_views import AnnotatedTokenVerifyView, TokenObtainPairView, TokenRefreshView from .views import home_view, ping urlpatterns = [ - path("", home_view, name="home"), - path("ping/", ping, name="ping"), - # Django Admin, use {% url 'admin:index' %} - path(settings.ADMIN_URL, admin.site.urls), - # Rest API - path("api/v1/auth/login/", TokenObtainPairView.as_view(), name="token_obtain_pair"), - path( - "api/v1/auth/token/refresh/", TokenRefreshView.as_view(), name="token_refresh" - ), - path( - "api/v1/auth/token/verify/", - AnnotatedTokenVerifyView.as_view(), - name="token_verify", - ), - path( - "api/v1/password_reset/", - ResetPasswordRequestToken.as_view(), - name="password_reset_request", - ), - path( - "api/v1/password_reset/confirm/", - ResetPasswordConfirm.as_view(), - name="password_reset_confirm", - ), - path( - "api/v1/password_reset/check/", - ResetPasswordCheck.as_view(), - name="password_reset_check", - ), - path( - "api/v1/password_change/", - ChangePasswordView.as_view(), - name="change_password_view", - ), - path("api/v1/", include(api_router.urlpatterns)), - # Hcx Listeners - path( - "coverageeligibility/on_check", - CoverageElibilityOnCheckView.as_view(), - name="hcx_coverage_eligibility_on_check", - ), - path( - "preauth/on_submit", - PreAuthOnSubmitView.as_view(), - name="hcx_pre_auth_on_submit", - ), - path( - "claim/on_submit", - ClaimOnSubmitView.as_view(), - name="hcx_claim_on_submit", - ), - path( - "communication/request", - CommunicationRequestView.as_view(), - name="hcx_communication_on_request", - ), - # Health check urls - path("middleware/verify", MiddlewareAuthenticationVerifyView.as_view()), - path( - ".well-known/openid-configuration", - OpenIdConfigView.as_view(), - name="openid-configuration", - ), - path("health/", include("healthy_django.urls", namespace="healthy_django")), - ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) + path("", home_view, name="home"), + path("ping/", ping, name="ping"), + # Django Admin, use {% url 'admin:index' %} + path(settings.ADMIN_URL, admin.site.urls), + # Rest API + path("api/v1/auth/login/", TokenObtainPairView.as_view(), name="token_obtain_pair"), + path( + "api/v1/auth/token/refresh/", TokenRefreshView.as_view(), name="token_refresh" + ), + path( + "api/v1/auth/token/verify/", + AnnotatedTokenVerifyView.as_view(), + name="token_verify", + ), + path( + "api/v1/password_reset/", + ResetPasswordRequestToken.as_view(), + name="password_reset_request", + ), + path( + "api/v1/password_reset/confirm/", + ResetPasswordConfirm.as_view(), + name="password_reset_confirm", + ), + path( + "api/v1/password_reset/check/", + ResetPasswordCheck.as_view(), + name="password_reset_check", + ), + path( + "api/v1/password_change/", + ChangePasswordView.as_view(), + name="change_password_view", + ), + path("api/v1/", include(api_router.urlpatterns)), + # Hcx Listeners + path( + "coverageeligibility/on_check", + CoverageElibilityOnCheckView.as_view(), + name="hcx_coverage_eligibility_on_check", + ), + path( + "preauth/on_submit", + PreAuthOnSubmitView.as_view(), + name="hcx_pre_auth_on_submit", + ), + path( + "claim/on_submit", + ClaimOnSubmitView.as_view(), + name="hcx_claim_on_submit", + ), + path( + "communication/request", + CommunicationRequestView.as_view(), + name="hcx_communication_on_request", + ), + # Health check urls + path("middleware/verify", MiddlewareAuthenticationVerifyView.as_view()), + path( + ".well-known/openid-configuration", + OpenIdConfigView.as_view(), + name="openid-configuration", + ), + path("health/", include("healthy_django.urls", namespace="healthy_django")), +] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) if settings.ENABLE_ABDM: urlpatterns += abdm_urlpatterns From f5bfcdf6bac5b94371070f295a2a756f8322996c Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 15:49:12 +0530 Subject: [PATCH 03/13] make care installable install using `pip install /path/to/care/` --- setup.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 setup.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..996cb5544b --- /dev/null +++ b/setup.py @@ -0,0 +1,24 @@ +from setuptools import find_packages, setup + +setup( + name="care", + version="0.1", + packages=find_packages(include=["care", "care.*"]), + include_package_data=True, + install_requires=[], + author="Open Healthcare Network", + author_email="care@ops.ohc.network", + description="A Django app for managing healthcare across hospitals and care centers.", + license="MIT", + keywords="django care ohc", + url="https://github.com/coronasafe/care", + classifiers=[ + "Development Status :: 3 - Alpha", + "Framework :: Django", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + ], +) From ab3290818632b75b3ea9a8c59082edc3f87fb592 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 15:50:08 +0530 Subject: [PATCH 04/13] change root url of apps from / to /api to make the accessible via reverse proxy --- config/urls.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/urls.py b/config/urls.py index f19b0603e7..a79e444d4f 100644 --- a/config/urls.py +++ b/config/urls.py @@ -145,4 +145,4 @@ ] for plug in settings.PLUGIN_APPS: - urlpatterns += [path(f"{plug}/", include(f"{plug}.urls"))] + urlpatterns += [path(f"api/{plug}/", include(f"{plug}.urls"))] From ce146bfe76d5a83a8c303334674d27c7d52a90d2 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 17:22:44 +0530 Subject: [PATCH 05/13] crete abstract file upload model --- care/facility/api/serializers/file_upload.py | 4 +- ...alter_fileupload_file_category_and_more.py | 43 +++++++ care/facility/models/file_upload.py | 121 ++++++++++-------- 3 files changed, 115 insertions(+), 53 deletions(-) create mode 100644 care/facility/migrations/0424_alter_fileupload_file_category_and_more.py diff --git a/care/facility/api/serializers/file_upload.py b/care/facility/api/serializers/file_upload.py index e991cf045a..42d4e7c58c 100644 --- a/care/facility/api/serializers/file_upload.py +++ b/care/facility/api/serializers/file_upload.py @@ -119,8 +119,8 @@ def check_permissions(file_type, associating_id, user, action="create"): class FileUploadCreateSerializer(serializers.ModelSerializer): id = serializers.UUIDField(source="external_id", read_only=True) - file_type = ChoiceField(choices=FileUpload.FileTypeChoices) - file_category = ChoiceField(choices=FileUpload.FileCategoryChoices, required=False) + file_type = ChoiceField(choices=FileUpload.FileType.choices) + file_category = ChoiceField(choices=FileUpload.FileCategory.choices, required=False) signed_url = serializers.CharField(read_only=True) associating_id = serializers.CharField(write_only=True) diff --git a/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py b/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py new file mode 100644 index 0000000000..792cc75526 --- /dev/null +++ b/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py @@ -0,0 +1,43 @@ +# Generated by Django 4.2.10 on 2024-04-02 11:49 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("facility", "0423_patientconsultation_consent_records_and_more"), + ] + + operations = [ + migrations.AlterField( + model_name="fileupload", + name="file_category", + field=models.CharField( + choices=[ + ("UNSPECIFIED", "Unspecified"), + ("XRAY", "Xray"), + ("AUDIO", "Audio"), + ("IDENTITY_PROOF", "Identity Proof"), + ], + default="UNSPECIFIED", + max_length=100, + ), + ), + migrations.AlterField( + model_name="fileupload", + name="file_type", + field=models.IntegerField( + choices=[ + (0, "Other"), + (1, "Patient"), + (2, "Consultation"), + (3, "Sample Management"), + (4, "Claim"), + (5, "Discharge Summary"), + (6, "Communication"), + (7, "Consent Record"), + ], + default=1, + ), + ), + ] diff --git a/care/facility/models/file_upload.py b/care/facility/models/file_upload.py index 9f5e1e04af..25dd58a34d 100644 --- a/care/facility/models/file_upload.py +++ b/care/facility/models/file_upload.py @@ -1,79 +1,53 @@ -import enum import time from uuid import uuid4 import boto3 +from django.contrib.auth import get_user_model from django.db import models -from care.facility.models import FacilityBaseModel -from care.users.models import User from care.utils.csp.config import BucketType, get_client_config +from care.utils.models.base import BaseManager +User = get_user_model() -class FileUpload(FacilityBaseModel): - """ - Stores data about all file uploads - the file can belong to any type ie Patient , Consultation , Daily Round and so on ... - the file will be uploaded to the corresponding folders - the file name will be randomised and converted into an internal name before storing in S3 - all data will be private and file access will be given on a NEED TO BASIS ONLY - """ - - # TODO : Periodic tasks that removes files that were never uploaded - - class FileType(enum.Enum): - PATIENT = 1 - CONSULTATION = 2 - SAMPLE_MANAGEMENT = 3 - CLAIM = 4 - DISCHARGE_SUMMARY = 5 - COMMUNICATION = 6 - CONSENT_RECORD = 7 - class FileCategory(enum.Enum): +class BaseFileUpload(models.Model): + class FileCategory(models.TextChoices): UNSPECIFIED = "UNSPECIFIED" XRAY = "XRAY" AUDIO = "AUDIO" IDENTITY_PROOF = "IDENTITY_PROOF" - FileTypeChoices = [(e.value, e.name) for e in FileType] - FileCategoryChoices = [(e.value, e.name) for e in FileCategory] + external_id = models.UUIDField(default=uuid4, unique=True, db_index=True) name = models.CharField(max_length=2000) # name should not contain file extension internal_name = models.CharField( max_length=2000 ) # internal_name should include file extension associating_id = models.CharField(max_length=100, blank=False, null=False) - upload_completed = models.BooleanField(default=False) - is_archived = models.BooleanField(default=False) - archive_reason = models.TextField(blank=True) - uploaded_by = models.ForeignKey( - User, - on_delete=models.PROTECT, - null=True, - blank=True, - related_name="uploaded_by", - ) - archived_by = models.ForeignKey( - User, - on_delete=models.PROTECT, - null=True, - blank=True, - related_name="archived_by", - ) - archived_datetime = models.DateTimeField(blank=True, null=True) - file_type = models.IntegerField( - choices=FileTypeChoices, default=FileType.PATIENT.value - ) + file_type = models.IntegerField(default=0) file_category = models.CharField( - choices=FileCategoryChoices, - default=FileCategory.UNSPECIFIED.value, + choices=FileCategory.choices, + default=FileCategory.UNSPECIFIED, max_length=100, ) + created_date = models.DateTimeField( + auto_now_add=True, null=True, blank=True, db_index=True + ) + modified_date = models.DateTimeField( + auto_now=True, null=True, blank=True, db_index=True + ) + upload_completed = models.BooleanField(default=False) + deleted = models.BooleanField(default=False, db_index=True) - def get_extension(self): - parts = self.internal_name.split(".") - return f".{parts[-1]}" if len(parts) > 1 else "" + objects = BaseManager() + + class Meta: + abstract = True + + def delete(self, *args): + self.deleted = True + self.save(update_fields=["deleted"]) def save(self, *args, **kwargs): if "force_insert" in kwargs or (not self.internal_name): @@ -85,6 +59,10 @@ def save(self, *args, **kwargs): self.internal_name = internal_name return super().save(*args, **kwargs) + def get_extension(self): + parts = self.internal_name.split(".") + return f".{parts[-1]}" if len(parts) > 1 else "" + def signed_url( self, duration=60 * 60, mime_type=None, bucket_type=BucketType.PATIENT ): @@ -138,3 +116,44 @@ def file_contents(self): content_type = response["ContentType"] content = response["Body"].read() return content_type, content + + +class FileUpload(BaseFileUpload): + """ + Stores data about all file uploads + the file can belong to any type ie Patient , Consultation , Daily Round and so on ... + the file will be uploaded to the corresponding folders + the file name will be randomised and converted into an internal name before storing in S3 + all data will be private and file access will be given on a NEED TO BASIS ONLY + """ + + # TODO : Periodic tasks that removes files that were never uploaded + + class FileType(models.IntegerChoices): + OTHER = 0 + PATIENT = 1 + CONSULTATION = 2 + SAMPLE_MANAGEMENT = 3 + CLAIM = 4 + DISCHARGE_SUMMARY = 5 + COMMUNICATION = 6 + CONSENT_RECORD = 7 + + file_type = models.IntegerField(choices=FileType.choices, default=FileType.PATIENT) + is_archived = models.BooleanField(default=False) + archive_reason = models.TextField(blank=True) + uploaded_by = models.ForeignKey( + User, + on_delete=models.PROTECT, + null=True, + blank=True, + related_name="uploaded_by", + ) + archived_by = models.ForeignKey( + User, + on_delete=models.PROTECT, + null=True, + blank=True, + related_name="archived_by", + ) + archived_datetime = models.DateTimeField(blank=True, null=True) From 55d56da846444dbade2f9d3dfa0eb7e4e62aa479 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 20:02:01 +0530 Subject: [PATCH 06/13] fix file upload api --- care/facility/api/serializers/file_upload.py | 4 ++-- care/facility/models/file_upload.py | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/care/facility/api/serializers/file_upload.py b/care/facility/api/serializers/file_upload.py index 42d4e7c58c..e991cf045a 100644 --- a/care/facility/api/serializers/file_upload.py +++ b/care/facility/api/serializers/file_upload.py @@ -119,8 +119,8 @@ def check_permissions(file_type, associating_id, user, action="create"): class FileUploadCreateSerializer(serializers.ModelSerializer): id = serializers.UUIDField(source="external_id", read_only=True) - file_type = ChoiceField(choices=FileUpload.FileType.choices) - file_category = ChoiceField(choices=FileUpload.FileCategory.choices, required=False) + file_type = ChoiceField(choices=FileUpload.FileTypeChoices) + file_category = ChoiceField(choices=FileUpload.FileCategoryChoices, required=False) signed_url = serializers.CharField(read_only=True) associating_id = serializers.CharField(write_only=True) diff --git a/care/facility/models/file_upload.py b/care/facility/models/file_upload.py index 25dd58a34d..c20685e8d4 100644 --- a/care/facility/models/file_upload.py +++ b/care/facility/models/file_upload.py @@ -157,3 +157,7 @@ class FileType(models.IntegerChoices): related_name="archived_by", ) archived_datetime = models.DateTimeField(blank=True, null=True) + + # TODO: switch to Choices.choices + FileTypeChoices = [(x.value, x.name) for x in FileType] + FileCategoryChoices = [(x.value, x.name) for x in BaseFileUpload.FileCategory] From 25af85389ff3dd04853d74a978c9b1422d152204 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 23:29:21 +0530 Subject: [PATCH 07/13] add care_scribe config vars --- plug_config.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/plug_config.py b/plug_config.py index 9edad7cb48..4e024d02f5 100644 --- a/plug_config.py +++ b/plug_config.py @@ -1,11 +1,19 @@ +import environ + from plugs.manager import PlugManager from plugs.plug import Plug +env = environ.Env() + scribe_plug = Plug( name="care_scribe", package_name="git+https://github.com/coronasafe/care_scribe.git", - version="@master", - configs={}, + version="@scribe", + configs={ + "TRANSCRIBE_SERVICE_PROVIDER_API_KEY": env( + "TRANSCRIBE_SERVICE_PROVIDER_API_KEY" + ), + }, ) plugs = [scribe_plug] From 358a47d10a9094789570b90e715088336e720adf Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Tue, 2 Apr 2024 23:38:04 +0530 Subject: [PATCH 08/13] fix plug class --- plugs/plug.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugs/plug.py b/plugs/plug.py index 8a94b6a49a..043dfe5063 100644 --- a/plugs/plug.py +++ b/plugs/plug.py @@ -3,7 +3,7 @@ class Plug: Abstraction of a plugin """ - def __init__(self, name, package_name, version, **configs): + def __init__(self, name, package_name, version, configs): self.name = name self.package_name = package_name self.version = version From 01f5e5d012bf41e1ec0c447bbd1b185655acdd70 Mon Sep 17 00:00:00 2001 From: vigneshhari Date: Fri, 12 Apr 2024 17:00:14 +0530 Subject: [PATCH 09/13] Add check before installing plugs --- .gitignore | 1 + plugs/manager.py | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index ce2d3a5bab..4acdd07d9f 100644 --- a/.gitignore +++ b/.gitignore @@ -355,3 +355,4 @@ secrets.sh /.idea/misc.xml /.idea/modules.xml /.idea/vcs.xml +/.idea/ruff.xml diff --git a/plugs/manager.py b/plugs/manager.py index f080bb9570..c9216b31e6 100644 --- a/plugs/manager.py +++ b/plugs/manager.py @@ -13,9 +13,10 @@ def __init__(self, plugs): def install(self): packages = [x.package_name + x.version for x in self.plugs] - subprocess.check_call( - [sys.executable, "-m", "pip", "install", " ".join(packages)] - ) + if packages: + subprocess.check_call( + [sys.executable, "-m", "pip", "install", " ".join(packages)] + ) def get_apps(self): return [plug.name for plug in self.plugs] From b16c9a3c2363dc57e474db2d1d1158115e080123 Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Fri, 12 Apr 2024 17:50:13 +0530 Subject: [PATCH 10/13] make file choice labels compatible with previous enums to avoid issues --- ...alter_fileupload_file_category_and_more.py | 43 ------------------- .../0426_alter_fileupload_file_type.py | 29 +++++++++++++ care/facility/models/file_upload.py | 24 +++++------ 3 files changed, 41 insertions(+), 55 deletions(-) delete mode 100644 care/facility/migrations/0424_alter_fileupload_file_category_and_more.py create mode 100644 care/facility/migrations/0426_alter_fileupload_file_type.py diff --git a/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py b/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py deleted file mode 100644 index 792cc75526..0000000000 --- a/care/facility/migrations/0424_alter_fileupload_file_category_and_more.py +++ /dev/null @@ -1,43 +0,0 @@ -# Generated by Django 4.2.10 on 2024-04-02 11:49 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - dependencies = [ - ("facility", "0423_patientconsultation_consent_records_and_more"), - ] - - operations = [ - migrations.AlterField( - model_name="fileupload", - name="file_category", - field=models.CharField( - choices=[ - ("UNSPECIFIED", "Unspecified"), - ("XRAY", "Xray"), - ("AUDIO", "Audio"), - ("IDENTITY_PROOF", "Identity Proof"), - ], - default="UNSPECIFIED", - max_length=100, - ), - ), - migrations.AlterField( - model_name="fileupload", - name="file_type", - field=models.IntegerField( - choices=[ - (0, "Other"), - (1, "Patient"), - (2, "Consultation"), - (3, "Sample Management"), - (4, "Claim"), - (5, "Discharge Summary"), - (6, "Communication"), - (7, "Consent Record"), - ], - default=1, - ), - ), - ] diff --git a/care/facility/migrations/0426_alter_fileupload_file_type.py b/care/facility/migrations/0426_alter_fileupload_file_type.py new file mode 100644 index 0000000000..fd371a24fd --- /dev/null +++ b/care/facility/migrations/0426_alter_fileupload_file_type.py @@ -0,0 +1,29 @@ +# Generated by Django 4.2.10 on 2024-04-12 12:10 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("facility", "0425_merge_20240403_2055"), + ] + + operations = [ + migrations.AlterField( + model_name="fileupload", + name="file_type", + field=models.IntegerField( + choices=[ + (0, "OTHER"), + (1, "PATIENT"), + (2, "CONSULTATION"), + (3, "SAMPLE_MANAGEMENT"), + (4, "CLAIM"), + (5, "DISCHARGE_SUMMARY"), + (6, "COMMUNICATION"), + (7, "CONSENT_RECORD"), + ], + default=1, + ), + ), + ] diff --git a/care/facility/models/file_upload.py b/care/facility/models/file_upload.py index c20685e8d4..56a140fd5d 100644 --- a/care/facility/models/file_upload.py +++ b/care/facility/models/file_upload.py @@ -13,10 +13,10 @@ class BaseFileUpload(models.Model): class FileCategory(models.TextChoices): - UNSPECIFIED = "UNSPECIFIED" - XRAY = "XRAY" - AUDIO = "AUDIO" - IDENTITY_PROOF = "IDENTITY_PROOF" + UNSPECIFIED = "UNSPECIFIED", "UNSPECIFIED" + XRAY = "XRAY", "XRAY" + AUDIO = "AUDIO", "AUDIO" + IDENTITY_PROOF = "IDENTITY_PROOF", "IDENTITY_PROOF" external_id = models.UUIDField(default=uuid4, unique=True, db_index=True) @@ -130,14 +130,14 @@ class FileUpload(BaseFileUpload): # TODO : Periodic tasks that removes files that were never uploaded class FileType(models.IntegerChoices): - OTHER = 0 - PATIENT = 1 - CONSULTATION = 2 - SAMPLE_MANAGEMENT = 3 - CLAIM = 4 - DISCHARGE_SUMMARY = 5 - COMMUNICATION = 6 - CONSENT_RECORD = 7 + OTHER = 0, "OTHER" + PATIENT = 1, "PATIENT" + CONSULTATION = 2, "CONSULTATION" + SAMPLE_MANAGEMENT = 3, "SAMPLE_MANAGEMENT" + CLAIM = 4, "CLAIM" + DISCHARGE_SUMMARY = 5, "DISCHARGE_SUMMARY" + COMMUNICATION = 6, "COMMUNICATION" + CONSENT_RECORD = 7, "CONSENT_RECORD" file_type = models.IntegerField(choices=FileType.choices, default=FileType.PATIENT) is_archived = models.BooleanField(default=False) From 21f37fa447e26b047353b3035c37aa54f4b3f1cb Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Fri, 12 Apr 2024 19:24:01 +0530 Subject: [PATCH 11/13] add docs to configure plugins --- docs/index.rst | 1 + docs/pluggable-apps/configuration.rst | 38 +++++++++++++++++++++++++++ plug_config.py | 15 ++--------- 3 files changed, 41 insertions(+), 13 deletions(-) create mode 100644 docs/pluggable-apps/configuration.rst diff --git a/docs/index.rst b/docs/index.rst index 9d8069158a..66b3e8b7af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,7 @@ Welcome to Care's documentation! pycharm/configuration working-components/configuration django-configuration/configuration + pluggable-apps/configuration django-commands/configuration github-repo/configuration others/configuration diff --git a/docs/pluggable-apps/configuration.rst b/docs/pluggable-apps/configuration.rst new file mode 100644 index 0000000000..9fb083a3c3 --- /dev/null +++ b/docs/pluggable-apps/configuration.rst @@ -0,0 +1,38 @@ +Pluggable Apps +============== + +Care supports plugins that can be used to extend its functionality. Plugins are basically django apps that are defined in the `plug_config.py`. +These plugins can be automatically loaded during docker image build or run time, however its recommended to include them during docker image build time. +The default care image does not include any plugins, but you can create your own plugin config by overriding the `plug_config.py` file. + + +example `plug_config.py` file: + +.. code-block:: python + + from plugs.manager import PlugManager + from plugs.plug import Plug + + scribe_plug = Plug( + name="care_scribe", + package_name="git+https://github.com/coronasafe/care_scribe.git", + version="@master", + configs={ + "TRANSCRIBE_SERVICE_PROVIDER_API_KEY": "secret", + }, + ) + + plugs = [scribe_plug] + + manager = PlugManager(plugs) + + +Plugin config +------------- + +Each plugin will define their own config with some defaults, they can also pick the values from the environment variables if required. +The order of precedence is as follows: + +* Environment variables +* Configs defined in the `plug_config.py` +* Default values defined in the plugin diff --git a/plug_config.py b/plug_config.py index 4e024d02f5..4d93f29a4e 100644 --- a/plug_config.py +++ b/plug_config.py @@ -1,21 +1,10 @@ import environ from plugs.manager import PlugManager -from plugs.plug import Plug +from plugs.plug import Plug # noqa F401 env = environ.Env() -scribe_plug = Plug( - name="care_scribe", - package_name="git+https://github.com/coronasafe/care_scribe.git", - version="@scribe", - configs={ - "TRANSCRIBE_SERVICE_PROVIDER_API_KEY": env( - "TRANSCRIBE_SERVICE_PROVIDER_API_KEY" - ), - }, -) - -plugs = [scribe_plug] +plugs = [] manager = PlugManager(plugs) From c41b958382a60f7b7fb738ec622315c0045bdf03 Mon Sep 17 00:00:00 2001 From: vigneshhari Date: Fri, 12 Apr 2024 20:42:54 +0530 Subject: [PATCH 12/13] Remove unused vars. --- plug_config.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/plug_config.py b/plug_config.py index 4d93f29a4e..a99af83fc5 100644 --- a/plug_config.py +++ b/plug_config.py @@ -1,9 +1,4 @@ -import environ - from plugs.manager import PlugManager -from plugs.plug import Plug # noqa F401 - -env = environ.Env() plugs = [] From 00b3d786ab44348ca8070f57ddea6648a8aad65b Mon Sep 17 00:00:00 2001 From: Aakash Singh Date: Fri, 12 Apr 2024 22:47:02 +0530 Subject: [PATCH 13/13] update docs --- Pipfile | 1 + Pipfile.lock | 94 ++++++++++++++++++++++++++- docs/conf.py | 2 +- docs/pluggable-apps/configuration.md | 57 ++++++++++++++++ docs/pluggable-apps/configuration.rst | 38 ----------- 5 files changed, 151 insertions(+), 41 deletions(-) create mode 100644 docs/pluggable-apps/configuration.md delete mode 100644 docs/pluggable-apps/configuration.rst diff --git a/Pipfile b/Pipfile index d4ffa91468..b6586ba774 100644 --- a/Pipfile +++ b/Pipfile @@ -71,6 +71,7 @@ werkzeug = "==2.3.8" [docs] furo = "==2023.9.10" sphinx = "==7.2.6" +myst-parser = "==2.0.0" [requires] python_version = "3.11" diff --git a/Pipfile.lock b/Pipfile.lock index 8bbef9e4ff..0e22cc9f7f 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "d3f8439435571930893eb20d0599cf4de93bfb4646965c3725af4fdd966b8138" + "sha256": "c5a63e53b98f2ef609bf9957685d8e9246b34b0c260e860b0292d082f7bc52c5" }, "pipfile-spec": 6, "requires": { @@ -2493,6 +2493,14 @@ "markers": "python_version >= '3.7'", "version": "==3.1.3" }, + "markdown-it-py": { + "hashes": [ + "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", + "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb" + ], + "markers": "python_version >= '3.8'", + "version": "==3.0.0" + }, "markupsafe": { "hashes": [ "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf", @@ -2559,6 +2567,31 @@ "markers": "python_version >= '3.7'", "version": "==2.1.5" }, + "mdit-py-plugins": { + "hashes": [ + "sha256:b51b3bb70691f57f974e257e367107857a93b36f322a9e6d44ca5bf28ec2def9", + "sha256:d8ab27e9aed6c38aa716819fedfde15ca275715955f8a185a8e1cf90fb1d2c1b" + ], + "markers": "python_version >= '3.8'", + "version": "==0.4.0" + }, + "mdurl": { + "hashes": [ + "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", + "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba" + ], + "markers": "python_version >= '3.7'", + "version": "==0.1.2" + }, + "myst-parser": { + "hashes": [ + "sha256:7c36344ae39c8e740dad7fdabf5aa6fc4897a813083c6cc9990044eb93656b14", + "sha256:ea929a67a6a0b1683cdbe19b8d2e724cd7643f8aa3e7bb18dd65beac3483bead" + ], + "index": "pypi", + "markers": "python_version >= '3.8'", + "version": "==2.0.0" + }, "packaging": { "hashes": [ "sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5", @@ -2575,6 +2608,63 @@ "markers": "python_version >= '3.7'", "version": "==2.17.2" }, + "pyyaml": { + "hashes": [ + "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5", + "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc", + "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df", + "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741", + "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206", + "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27", + "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595", + "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62", + "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98", + "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696", + "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290", + "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9", + "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d", + "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6", + "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867", + "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47", + "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486", + "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6", + "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3", + "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007", + "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938", + "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0", + "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c", + "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735", + "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d", + "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28", + "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4", + "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba", + "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8", + "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef", + "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5", + "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd", + "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3", + "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0", + "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515", + "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c", + "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c", + "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924", + "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34", + "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43", + "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859", + "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673", + "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54", + "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a", + "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b", + "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab", + "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa", + "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c", + "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585", + "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d", + "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f" + ], + "markers": "python_version >= '3.6'", + "version": "==6.0.1" + }, "requests": { "hashes": [ "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f", @@ -2669,7 +2759,7 @@ "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d", "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19" ], - "markers": "python_version >= '3.8'", + "markers": "python_version >= '3.6'", "version": "==2.2.1" } } diff --git a/docs/conf.py b/docs/conf.py index 02636605ad..ea31c5ef15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ["myst_parser"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/pluggable-apps/configuration.md b/docs/pluggable-apps/configuration.md new file mode 100644 index 0000000000..adfeed3e86 --- /dev/null +++ b/docs/pluggable-apps/configuration.md @@ -0,0 +1,57 @@ +# Pluggable Apps + + +## Overview + +Care supports plugins that can be used to extend its functionality. Plugins are basically django apps that are defined in the `plug_config.py`. +These plugins can be automatically loaded during docker image build or run time, however its recommended to include them during docker image build time. +The default care image does not include any plugins, but you can create your own plugin config by overriding the `plug_config.py` file. + + +example `plug_config.py` file: + +```python + +from plugs.manager import PlugManager +from plugs.plug import Plug + +my_plugin = Plug( + name="my_plugin", + package_name="git+https://github.com/octo/my_plugin.git", + version="@v1.0.0", + configs={ + "SERVICE_API_KEY": "my_api_key", + "SERVICE_SECRET_KEY": "my_secret_key", + "VALUE_1_MAX": 10, + }, +) + +plugs = [my_plugin] + +manager = PlugManager(plugs) +``` + +## Plugin config variables + +Each plugin will define their own config variables with some defaults, they can also pick the values from the environment variables if required. +The order of precedence is as follows: + +- Environment variables +- Configs defined in the `plug_config.py` +- Default values defined in the plugin + + +## Development + +To get started with developing a plugin, use [care-plugin-cookiecutter](https://github.com/coronasafe/care-plugin-cookiecutter) +The plugin follows the structure of a typical django app where you can define your models, views, urls, etc. in the plugin folder. +The plugin manager will automatically load the required configurations and plugin urls under `/api/plugin-name/`. + +To develop the plugins locally you can install the plugin in the editable mode using `pip install -e /path/to/plugin`. + +If you need to inherit the components from the core app, you can install care in editable mode in the plugin using `pip install -e /path/to/care`. + + +## Available Plugins + +- [Care Scribe](https://github.com/coronasafe/care_scribe): Care Scribe is a plugin that provides autofill functionality for the care consultation forms. diff --git a/docs/pluggable-apps/configuration.rst b/docs/pluggable-apps/configuration.rst deleted file mode 100644 index 9fb083a3c3..0000000000 --- a/docs/pluggable-apps/configuration.rst +++ /dev/null @@ -1,38 +0,0 @@ -Pluggable Apps -============== - -Care supports plugins that can be used to extend its functionality. Plugins are basically django apps that are defined in the `plug_config.py`. -These plugins can be automatically loaded during docker image build or run time, however its recommended to include them during docker image build time. -The default care image does not include any plugins, but you can create your own plugin config by overriding the `plug_config.py` file. - - -example `plug_config.py` file: - -.. code-block:: python - - from plugs.manager import PlugManager - from plugs.plug import Plug - - scribe_plug = Plug( - name="care_scribe", - package_name="git+https://github.com/coronasafe/care_scribe.git", - version="@master", - configs={ - "TRANSCRIBE_SERVICE_PROVIDER_API_KEY": "secret", - }, - ) - - plugs = [scribe_plug] - - manager = PlugManager(plugs) - - -Plugin config -------------- - -Each plugin will define their own config with some defaults, they can also pick the values from the environment variables if required. -The order of precedence is as follows: - -* Environment variables -* Configs defined in the `plug_config.py` -* Default values defined in the plugin