https://github.com/smashedtoatoms/address_us

US Address Parsing for Elixir.
https://github.com/smashedtoatoms/address_us

Last synced: 3 months ago
JSON representation

US Address Parsing for Elixir.

• Host: GitHub
• URL: https://github.com/smashedtoatoms/address_us
• Owner: smashedtoatoms
• License: apache-2.0
• Created: 2014-10-03T22:52:44.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T03:10:22.000Z (5 months ago)
• Last Synced: 2024-10-02T06:29:05.084Z (4 months ago)
• Language: Elixir
• Homepage:
• Size: 342 KB
• Stars: 30
• Watchers: 7
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Library for parsing US Addresses into their individual parts. (Miscellaneous)
• fucking-awesome-elixir - address_us - Library for parsing US Addresses into their individual parts. (Miscellaneous)
• awesome-elixir - address_us - Library for parsing US Addresses into their individual parts. (Miscellaneous)

README

        
AddressUS

=========

**US Address Parser**

This is an Elixir library for parsing US Addresses.  It parses single line

or multi-line addresses and largely ignores punctuation.  It closely follows

the [USPS guidelines](http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf) for address parsing, although it doesn't exactly follow it, particularly in cases where the address is particularly odd.  I hope to update it as I find exceptions.  The easiest way to see the usage is to check out the tests.  You

can also read the documentation [here](https://smashedtoatoms.github.io/address_us).  The basic rundown is this:

```

iex(1)> parse_address("1500 Serpentine Road Suite 100 Baltimore MD 21"

%Address{city: "Baltimore", postal: "00021", state: "MD", street: %Street{primary_number: "1500", suffix: "Rd", name: "Serpentine", secondary_designator: "Ste", secondary_number: "100"}}

```