/postcode-address-sg

Convert Singapore postal codes into addresses.

Primary LanguagePythonMIT LicenseMIT

Singapore Postal Code to Address Converter License: MIT

This Python CLI tool uses the One Map SG API to batch process postal codes and collect their address information.

Installation

The tool was created using Python 3.10.8. The dependencies required are:

  • pandas
  • requests
  • swifter

Usage

The CSV file inputted must have the heading "Postal Codes" for the column containing the postal codes. An example can be seen in postalcodes.csv. If the file name of the CSV inputted is the same as the example, running python main.py will suffice.

$ python main.py --help

usage: main.py [-h] [-i INPUT] [-o OUTPUT]

Converting Singapore Postal Code into Addresses.

options:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        The path to the CSV file with postal code data. Default: `postalcodes.csv`
  -o OUTPUT, --output OUTPUT
                        The path to the output CSV. Default: `postalcodeswithaddress.csv`.