Skip to content

[Ruby] CLI utilizing the USPS Web Tools™ API to standardize addresses

License

Notifications You must be signed in to change notification settings

VincePimentel/standardize-address

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Standardize Address

Address standardization is the process of formatting an address so that it matches the approved format of the national postal authority. The USPS determines the official format for addresses in the United States. This utility will take user input (incomplete address) and send a request to the USPS Web Tools server. The response will then be parsed and formatted that is readable to the user. The result is a standardized address that can be saved in memory for later viewing (no persistence as of yet).

Installation

Clone this repo via:

git clone git@github.com:VincePimentel/standardize-address.git

Usage

This gem utilizes the USPS Web Tools API so a username is required. To request one, click here. After acquiring a username, head to lib/standardize_address.rb and put your username under #username.

Run the program by typing the following at the root directory (standardize-address):

ruby bin/start

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/VincePimentel/standardize-address.

License

The gem is available as open source under the terms of the MIT License.

About

[Ruby] CLI utilizing the USPS Web Tools™ API to standardize addresses

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published