The IDVA GDrive microservice is a Python Fast API application that interfaces IDVA applications to the Google Drive API.
Make sure you have the following installed if you intend to build the project locally.
To set up your environment, run the following commands (or the equivalent commands if not using a bash-like terminal):
# Clone the project
git clone https://github.com/GSA-TTS/identity-idva-gdrive
cd identity-idva-gdrive
# Set up Python virtual environment
python3.11 -m venv .venv
source .venv/bin/activate
# .venv\Scripts\Activate.ps1 on Windows
# Install dependencies and pre-commit hooks
python -m pip install -r requirements-dev.txt
pre-commit install
The project can be ran locally with:
```shell
uvicorn gdrive.main:app
After completing development setup application locally with:
python -m pytest
Upload a single file
POST /upload
Query parameters:
id: <parent interaciton id>
filename: <see codenames>
base64: <is base 64>
Request body:
<file data>
Upload a single file
DELETE /upload
Query parameters:
filename: <see codenames>
Exports flow analytics from single interaction id.
POST /export
Query parameters:
interactionId: <parent flow interaciton id>
Exports analytics in bulk that are associated with a survey response. Also uploads participant data to google spread sheet. Data provided in the request body, as well as demographic data collected from Qualtrix api will be uploaded. Only responses that have a Complete status (user has completed the survey) will be uploaded to the google spead sheet.
POST /survey-export
Request body:
{
"surveyId": str
"responseId": str
"participant": {
"first": str
"last": str
"email": str
"time": str
}
}
All deployments require having the correct Cloud.gov credentials in place. If you haven't already, visit Cloud.gov and set up your account and CLI.
manifest.yml file contains the deployment configuration for cloud.gov, and expects a vars.yaml file that includes runtime variables referenced. For info, see cloud foundry manifest files reference
Running the following cf
command will deploy the application to cloud.gov
cf push --vars-file vars.yaml \
--var ENVIRONMENT=<env>
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.