{"id":43352362,"url":"https://github.com/dimagi/abdm-python-integrator","last_synced_at":"2026-02-02T02:32:58.631Z","repository":{"id":193510161,"uuid":"688940081","full_name":"dimagi/abdm-python-integrator","owner":"dimagi","description":"A Django app that implements ABDM milestones","archived":false,"fork":false,"pushed_at":"2024-04-23T09:36:53.000Z","size":298,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-01T11:28:03.525Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dimagi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-09-08T12:30:17.000Z","updated_at":"2023-09-08T12:50:31.000Z","dependencies_parsed_at":"2023-09-27T12:21:52.249Z","dependency_job_id":"bbd6a6e0-d41b-42ae-b633-370f617c838a","html_url":"https://github.com/dimagi/abdm-python-integrator","commit_stats":null,"previous_names":["dimagi/abdm-python-integrator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dimagi/abdm-python-integrator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fabdm-python-integrator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fabdm-python-integrator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fabdm-python-integrator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fabdm-python-integrator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dimagi","download_url":"https://codeload.github.com/dimagi/abdm-python-integrator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fabdm-python-integrator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29001654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T01:32:03.847Z","status":"online","status_checked_at":"2026-02-02T02:00:07.448Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-02T02:32:58.577Z","updated_at":"2026-02-02T02:32:58.625Z","avatar_url":"https://github.com/dimagi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# abdm-python-integrator\n\nABDM integrator is a REST API service packaged as a django app. \nIt implements all the three milestones of [ABDM](https://sandbox.abdm.gov.in/abdm-docs/getting-started).\nThis package is intended to be used by developers aiming to perform integration with ABDM using python.\n\n## Apps\nThe `abdm_integrator` includes below apps as per milestones:\n1. abha - features related to milestone 1 \n2. hip - features related to milestone 2 \n3. hiu - features related to milestone 3\n\nThese apps can be added to Django `INSTALLED_APPS` setting based on what milestone/service \nis needed for integration.\n\n## Requirements\n- python \u003e= 3.8\n- celery\n\nFor python dependencies, refer `dependencies` section in [pyproject.toml](pyproject.toml)\nFor celery, add desired configuration in django settings. Refer [Celery documentation](https://docs.celeryq.dev/en/stable/getting-started/introduction.html).\n\n## Installation\n\n```commandline\npip install abdm-python-integrator@git+https://github.com/dimagi/abdm-python-integrator.git\n```\n\n## Settings\n\n1. Add required apps to Django `INSTALLED_APPS` setting.\n    ```\n        'abdm_integrator.abha',\n        'abdm_integrator.hiu',\n        'abdm_integrator.hip',\n    ```\n\n2. Add below settings to your Django settings file.\n\n    ```python\n    ABDM_INTEGRATOR = {\n        # REQUIRED setting.\n        # Client ID provided by ABDM. \n        'CLIENT_ID': 'dummy-value',\n    \n        # REQUIRED setting.\n        # Client Secret provided by ABDM.\n        'CLIENT_SECRET': 'dummy-value',\n        \n        # REQUIRED setting.\n        # Consent Manager ID for ABDM as per environment.\n        # Below value is for ABDM sandbox environment.\n        'X_CM_ID': 'sbx',\n        \n        # REQUIRED setting.\n        # Base URL for Abha APIS (M1).\n        # Below value is for ABDM sandbox environment.\n        'ABHA_URL': 'https://healthidsbx.abdm.gov.in/api',\n        \n        # REQUIRED setting.\n        # Base URL for Gateway APIS (M2/M3 and Access Token).\n        # Below value is for ABDM sandbox environment.\n        'GATEWAY_URL': 'https://dev.abdm.gov.in/gateway',\n\n        # REQUIRED setting. \n        # Any Authentication class that is compatible with Rest Framework Authentication mechanism.\n        # Below value uses REST Framework Token Authentication.\n        'AUTHENTICATION_CLASS': 'rest_framework.authentication.TokenAuthentication',\n        \n        # OPTIONAL setting. Defaults to Django User model.\n        # A custom model can be specified as 'app_label.Model'\n        'USER_MODEL': 'auth.User',\n                \n        # Required setting. Default value points to `HRPIntegration` interface.\n        # Class responsible for implementing methods that talks with HRP. For e.g. to fetch health data.\n        # Must implement interface 'HRPIntegration' as defined in 'integrations.py'. Refer Interface docstring for details.\n        'HRP_INTEGRATION_CLASS': None,\n           \n        # OPTIONAL setting. Default value is None.\n        # Configurable setting that points to the Celery App Instance. \n        # If None, it uses the default celery app configured in Project.\n        'CELERY_APP': None,\n    \n        # OPTIONAL setting. Default value is None which mean celery default queue would be used.\n        # Queue to be used for running async operations for some of Gateway Facing APIs\n        'CELERY_QUEUE': None,\n   \n        # OPTIONAL setting. Default value is False.\n        # If set to True, parses FHIR bundle at the HIU end to a format easier to display on the UI.\n        'HIU_PARSE_FHIR_BUNDLE': False\n    }\n    ```\n\n3. Run migrations.\n\n    ```commandline\n    python manage.py migrate abdm_hiu\n    python manage.py migrate abdm_hip\n    ```\n\n4. Include app urls into your Django root url config.\n    ```\n    url(r'^abdm/', include('abdm_integrator.urls')),\n    ```\n\n\n## Testing\nRun the below command to run test cases. Uses settings as defined in `test_settings.py`\n```commandline\npython manage.py test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimagi%2Fabdm-python-integrator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdimagi%2Fabdm-python-integrator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimagi%2Fabdm-python-integrator/lists"}