Skip to content

Listing import scripts

Anders Schneider edited this page Sep 27, 2021 · 1 revision

The scripts we use to import listings live in backend/core/scripts. We have scripts that import from three different input sources (CSV file, JSON file, and ArcGIS), but in practice we only expect to handle CSV input files.

The current import-listings-from-from-csv.ts script is designed to be used as a one-time bulk upload of all listings recorded in an HRD-internal spreadsheet. Notes:

  • There is work scoped (https://github.com/CityOfDetroit/bloom/issues/628) to add the option to use this script to update listings (rather than just add new listings).
  • The current list of fields this script imports:
    • Project name
    • HRD ID
    • Listing address
    • Unit summaries: the unit type (e.g. "studio", "one bedroom") and the number of that type
    • AMI percentage min/max
    • Property management details (management company; property manager phone number, email address, website)
    • Property phone number
    • Owner company
    • Reserved community type (whether this listing is available only for e.g. seniors or those with certain accessibility needs)

We have work scoped (https://github.com/CityOfDetroit/bloom/issues/567) to add another CSV import script; this one will be designed to import data from the property manager survey. Notes:

  • This script will be implemented so that it can be run multiple times (each time updating existing listings).
  • The list of fields this script will be responsible for (https://github.com/CityOfDetroit/bloom/issues/396#issuecomment-909624118):
    • AMI percentages per unit type
    • Waitlist (is there an open waitlist?)
    • Link to application
    • Structured accessibility features (e.g. "elevator", "handicapped parking spots")
    • Property amenities
    • Application fee
    • Security deposit amount
    • Utility costs
    • Permanent supportive housing?
    • Application pick-up address
    • Min/max rent, per unit type