app

BAM's Automation API

This application is designed to house APIs which can be called from within Airtable via HTTP requests.

Currently, it has the following endpoints:

• /clean-record:
  • Cleans, formats, and performs DNS checks on email address domains via email-formatter.
  • Cleans and formats phone numbers via phonenumbers
  • Normalizes address via Google Maps API and NYC Planning Labs geosearch tool.
  • Parameters:
    • apikey: An apikey to provide security
    • email: The email address to validate
    • phone: The phone number to validate
    • dns_check: Whether or not to perform a dns check on the domain of the email address (defaults to false)
    • address: The address to normalize, including the apartment number.
    • city_state: The city and the state of the address to normalize.
    • zipcode: The zipcode of the address to normalize.

How do I install this locally?

Follow the setup guide in the README of this repository, then run the tests to confirm everything is working:

pytest -vv . # run the tests

How do I run this locally?

via docker

From the root of the repository run

docker compose build && docker-compose up

You should now have a version of the API running at http://localhost:3030

via python

After following the installation instructions above, run the following:

uvicorn bam_app.main:app --reload --port 3030 --host 0.0.0.0