Metadata-Version: 2.1
Name: dhis2
Version: 0.1.1
Summary: Tool for working and integrating with dhis2 instances.
Home-page: https://github.com/dhis2/dhis2-python-cli
Author: Morten Hansen
Author-email: morten@dhis2.org
License: BSD
Project-URL: Bug Reports, https://github.com/dhis2/dhis2-python-cli/issues
Project-URL: Source, https://github.com/dhis2/dhis2-python-cli
Description: # dhis2-python: integration client for dhis2
        
        [![Package version](https://badge.fury.io/py/dhis2.svg)](https://pypi.python.org/pypi/dhis2)
        
        **Requirements**: Python 3.8+
        
        ## Quickstart
        
        Install using `pip`:
        
        ```shell
        $ pip install dhis2
        ```
        
        This will install the `dhis2` command in your local environment (installing into a virtual environment recommended).
        
        The tool supports a pluggable architecture, but the core supports:
        
        * Inspecting dhis2 instances
            * `dhis2 -i inventory.yml inspect host-id/group-id`
        * Extracting mCSD and SVCM compatible payload, and pushing those to a FHIR compliant server
            * `dhis2 -i inventory.yml openhie mcsd mcsd-config.yml`
            * `dhis2 -i inventory.yml openhie svcm svcm-config.yml`
        
        (see description of formats below)
        
        As of now, we do not support sending data to dhis2, only extraction is supported.
        
        ## Formats
        
        ### Inventory
        
        The inventory is where you will store all your services, and various groupings you might find useful (most commands will only work on single sources/targets though, with the exception of the `inspect` command currently)
        
        The basic format is as follows
        
        ```yaml
        hosts:
          playdev:
            type: dhis2
            baseUrl: https://play.dhis2.org/dev
            username: admin
            password: district
          playdemo:
            type: dhis2
            baseUrl: https://play.dhis2.org/demo
            auth:
              default:
                type: http-basic
                username: admin
                password: district
          fhirdemo:
            type: fhir
            baseUrl: http://localhost:8080
        groups:
          dhis2:
            - playdev
            - playdemo
        ```
        
        The keys of the `hosts` and `groups` block will be used to identifiy targets when using the `dhis2` commands.
        
        Please note that:
        
        * Currently only `http-basic` is supported for dhis2
        * For fhir no authentication is supported (coming soon)
        
        ### mCSD / SVCM configuration
        
        Both mCSD and SVCM currently has the exact same format so we will describe them together. You will need a source host, target host (or some other target) and a set of filters if desired.
        
        Basic format
        
        ```yaml
        source:
          id: playdev
        target:
          id: fhirdemo
        ```
        
        This configuration would simply take all org unit or option sets inside of dhis2 and push them to a fhir instance.
        
        If you would want to store the result instead, you can use the `log://` target
        
        ```yaml
        source:
          id: playdev
        target:
          id: log://
        
        ```
        
        (this is also the default if no target is given)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8, <4
Description-Content-Type: text/markdown
