/carp.client-fastAPI

This is a sample project that provides all existing endpoints to communicate with the [CARP Webservices API](https://carp.cachet.dk) platform using the async framework, namely [FastAPI](http://fastapi.tiangolo.com).

Primary LanguagePythonMIT LicenseMIT

CARP CLIENT API - FastAPI

CACHET

The Copenhagen Center for Health Technology (CACHET) Research Platform (CARP) enables researchers to run mobile health (mHealth) studies where data is collected on participant's smartphones and wearable devices. Data is securely uploaded and managed in a hosting infrastructure managed by the Technical University of Denmark.

CARP is a platform for running research studies in the health domain – also known as Digital Phenotyping. Such studies range from technical feasibility studies of novel technology to large-scale clinical studies. The platform is very versatile both in terms of support for different types of health domains, as well as in terms of technical support and configuration.

Info

This is a sample project that provides all existing endpoints to communicate with the CARP Webservices API platform using the async framework, namely FastAPI.

Environments

Changing the [CARP] environment:

  • replace the environment in the following file: .env
  • i.e.: ENVIRONMENT=production, ENVIRONMENT=development, ENVIRONMENT=staging, ENVIRONMENT=test, ENVIRONMENT=local, default=local

Install requirements

Provision for Production:

  • ~cd into carp.client-fastapi directory and use the bash-command:
  • bash deployment.sh production up or bash deployment.sh local up for local environment.

Run locally:

  • ~cd into carp.client-fastapi directory and use the command:
  • uvicorn run:app --reload --port 8091

References