Skip to content

Latest commit

 

History

History
243 lines (170 loc) · 6.34 KB

README.md

File metadata and controls

243 lines (170 loc) · 6.34 KB
Raw

Primero API Python library (primero-api) [Experimental]

This is a python library to interact with the Primero IMS API.

This library is part of the magasin-primero-paquet project.

It's main goal is to enable data analysts to extract data programmatically from a Primero instance either for performing exploratory analysis or building a data pipeline.

Tested with primero 2.11.0-rc3.

Installation

pip install primero-api

Usage

from primero_api import PrimeroAPI

# Initialize the API client
# Replace the url, username and password with your own.
primero = PrimeroAPI(
    url='https://primero.example.com/api/v2/',
    username='primero',
    password='passw0rd!'
)
# Test the api connection
print(primero.get_server_version())
# '2.11.0-rc3'

In a production environment, it is recommended to use environment variables to provide the credentials.

export PRIMERO_USER='primero'
export PRIMERO_PASSWORD='primer0!'
export PRIMERO_API_URL='http://localhost/api/v2/'

Then you can use the following code to read the environment variables.

import os

PRIMERO_USER= os.getenv('PRIMERO_USER')
PRIMERO_PASSWORD= os.getenv('PRIMERO_PASSWORD')
PRIMERO_API_URL= os.getenv('PRIMERO_API_URL')

primero = PrimeroAPI(
    url=PRIMERO_API_URL,
    username=PRIMERO_USER,
    password=PRIMERO_PASSWORD
)

Interact with cases and the incidents

The API client, is mainly focused on data analysis so it basically provides a few methods to extract data from a Primero instance.

# Get cases
cases = primero.get_cases()

# Get incidents
incidents = primero.get_incidents()

By default the client will return the data in a pandas DataFrame format. Data is ANONYMIZED, that is, no personal identifiable information, and only a subset of the information stored in the primero case / incident is returned.

Primero manages sensitive personal information, so this approach follows privacy by design principle.

Additional fields and disabling anonymization

The fields that are retrieved by default are kept in the property non_pii_cols

print(primero.non_pii_cols)

If there is some data point that you need for your use case, you can use additional_fields option to get it. For example:

# Get cases with additional fields
cases = primero.get_cases(additional_fields=['name','date_of_birth'])
incidents = primero.get_incidents(additional_fields=['name','date_of_birth'])

You can even fully disable the anonymization by setting anonymize=False in the get_cases/get_incidents method.

cases = primero.get_cases(anonymize=False)
incidents = primero.get_incidents(anonymize=False)

Lastly, you can also get the raw data as a dictionary:

# Get cases as returned by the API
cases = primero.get_cases_raw()

# Get incidents
incidents = primero.get_incidents_raw()

In this case the data is returned is the resulting dict with the converted JSON provided by the API.

Interact with the reports

# Dictionary of reports in which the key is the id of the report
reports = primero.get_reports()

# Display the report id, name and language
for report in reports.values():
  print(report.id, report.name, report.lang, report.slug)

You can also get a report by its id

report = primero.get_report(1) # where 1 is the id of the report
print(report.id, report.name, report.lang, report.slug)

Get the data of a report

report = primero.get_report(1) # where 1 is the id of the report

# Get the data of the report as a pandas DataFrame
# This will process the original data and return it as a pandas DataFrame with the rows and columns
report_df =  report.to_pandas()
print(report_df)

# Get the raw data of the report as a dictionary
# This is the original data as returned by the API without any processing
print(report.report_data_dict)

Development

Get the repo

git clone https://github.com/unicef/magasin-primero-paquet

Go to the library folder

cd primero-magasin-paquet
cd primero_api

Install in edit mode

pip install -e ".[dev]"

Now you can edit the code and see the results when you run test code.

Unit Testing

To run the unit tests:

pytest tests

Integration testing

To run the integration tests, you need to have a running primero instance running and set the environment variables below.

export PRIMERO_USER='primero'
export PRIMERO_PASSWORD='primer0!'
export PRIMERO_API_URL='http://localhost/api/v2/'

If the environment variables are not set, the tests will use the default values:

PRIMERO_USER='primero'
PRIMERO_PASSWORD='primer0!'
PRIMERO_API_URL='http://localhost/api/v2/'

pytest integration_tests

Integration testing with environment file

Optionally, you can use a file to set these variables. Follow these steps:

  1. Create a copy the example file:

    cp integration_env.conf-sample integration_env.conf

  2. Then update the values in integration_env.conf with your own values.

  3. Run:

source integration_env.conf
pytest integration_tests  --verbose -s

All tests with code coverage

To run all the tests:

pytest --cov=primero_api

LICENSE

MIT License

Copyright (c) 2024 United Nations Children's Fund (UNICEF) https://unicef.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.