umcn-consent 2.0.0rc1

No project description provided

UMCN_Consent

A Python layer for UMCN research usage consent systems

Installation

pip install git+ssh://[e-mail]:ResearchBureau/umcn-consent.git

Usage

Set USER, PASWORD, CLIENT_ID and URL in your local environment

To check consent status for a patient:

import os
from umcn_consent.auth import authenticate
from umcn_consent.core import AuthenticatedClient


session = authenticate(username=os.getenv("USER"),
                       password=os.getenv("PASSWORD"),
                       client_id=os.getenv("CLIENT_ID"))

client = AuthenticatedClient(session=session, url=os.getenv("URL"))
client.has_given_consent(pid="12345") 

see examples/example.py

Contributing

How to contribute to this repo

Get the code

Fork this repo, create a feature branch

Set up environment

umcn_consent uses uv for dependency and package management

• Install uv (see uv docs)

• Create a virtual env. Go to the folder where you cloned umcn_consent and use

  uv sync 
  

• Install pre-commit hooks.

  pre-commit install
  

Add your code

Make your code contributions. Make sure document and add tests for new features. To automatically publish to pypi, increment the version number and push to master. See below.

Lint your code

• Run all tests
• Run pre-commit:

  pre-commit run
  

Publish

Create a pull request: https://github.com/ResearchBureau/umcn_consent/pulls

Incrementing the version number

A merged pull request will only be published to pypi if it has a new version number. To bump umcn_consent's version, do the following:

• umcn_consent uses semantic versioning Check whether your addition is a PATCH, MINOR or MAJOR version.

• Manually increment the version number: pyproject.toml -> version = "0.1.2"

• Add a brief description of your updates new version to HISTORY.md