How to Use the DS API

Main URL: http://family-promise-dev.us-east-1.elasticbeanstalk.com

/vizmap endpoint

Perform SQL query of database according to filters implemented by user. Only pick out the following columns, and include those in a single JSON object that will be sent to DS API:

• service_type_name from service_types table.

Plus:

• address
• address_line2
• city
• state
• zip
• country

from locations table.

*zip codes are pulled from github repo link and added to a dataframe based on pulled zip

/veteran_counts endpoint

A JSON object containing:

• recipient_id
• recipient_veteran_status

from recipients table.

/age_metric endpoint

A JSON object containing:

• recipient_id
• recipient_date_of_birth

from recipients table.

/eligibility endpoint

Accepts a string containing a household_id from the households table.

Returns a JSON object containing:

• resident_assistance_eligibility: bool
• reduced_bus_fare_eligiblity: bool

/total_served endpoint

Returns an integer representing the total number of recipients recorded in the database.

/families_served endpoint

Returns an integer representing the total number of families recorded in the database.

/children_served endpoint

Returns an integer representing the total number of children recorded in the database.

Docs

Running the DS application

• Create the .env file in the folder.
  • Add DATABASE_URL = postgresql://docker:****@localhost:5400/api-dev to the .env file.
    • That is only for spinning up the local instance for the DS API
  • Make sure the .env file matches the .env file that is in the non public documentation.
• run:pipenv install --dev to download all the dependencies.
• run:pipenv shell to start the pipenv environment.
• run:uvicorn app.main:app --reload to start running the fast api.

Updating the Elastic Beanstalk environment

1. Do a normal push to GitHub repo and wait for the changes to be approved and pushed to the main branch.
2. run:git pull to make sure code is perfect to deploy to Elastic Beanstalk.
3. run:git add --all to get all the changes to the api that has been made.
4. Change the version number in the main.py file. Example: 0.37.01

• run:git commit -m 'Depoying version 0.XX.XX to AWS' to get all the changes add.
• When you start to deploy the new changes to Elastic Beanstalk it will take latest commit you made.

5. run: eb init --region us-east-1 family-promise to create the Elastic Beanstalk files in the application.
   • This step will only be required if you have not deployed to the Elastic Beanstalk environment.
6. run:eb deploy --region us-east-1 family-promise-dev.

• Follow instruction that will given to you.
• You may have to grab your security credentials from AWS.

7. Do a final push to add the final version number to the GitHub repo.