GeoLiberator 0.2.1

A small module that cleans, parses and standardizes addresses

The-GeoLiberator-Python-Module

This module is an address parser. It takes in an address as an argument and outputs a standardized version. Otherwise, 'OTHER' will be the result if the parser fails. "It is alike a liberal because it takes in any variant addresses indiscriminately. And it is a liberator because it liberates the addresses from their inconsistencies." (Note: This module does not do address validation but it will parse any address you throw at it to the best of its ability)

Usage:

To start, import with your desired handle to call upon the module with ease,

import GeoLiberator as GL

GL.geoLiberate("123 Example St", 2) # '2' to parse the full address
#Output: 123 EXAMPLE STREET

GL.geoLiberate("123 Example St", 1) # '1' to parse the address house number
#Output: 123

GL.geoLiberate("123 Example St", 0) # '0' to parse the full street
#Output: EXAMPLE STREET

The first argument is any address of data type string.

The second argument, as you may have noticed, determines what gets parsed.

• 2 - Full Address
• 1 - House Number
• 0 - Full Street

The following function's first argument is a file containing a list of addresses. It automatically loops through the rows of addresses.

GL.autoGeoLiberate("file.txt", 0, "output_file_name.txt") # '0' to parse full street name
#If no output file name given, program will print all parsed addresses

Let's say 'file.txt' contains the following:

123 Bob Rd
321 N Johnson Aven
123-4 2nd St

For that really lengthy list of addresses in a file, it's reccommended to use autoGeoLiberate() in your program and run in a cli with the flag --status(-S for short) to monitor the module's progress.

For developmental purposes:

address_object = GL.GeoLiberator("123 Example St") # Create a 'GeoLiberator Object' with address as an argument
#This new address object can then be parsed using the dot operator like so:
address_object.getAddress()
address_object.getAddressNum()
address_object.getStreet()

The attributes that can me applied to this GeoLiberator/ Address object return string values. Function Parameters:

getAddress(log = '', mode=False)

The 'log' parameter is for entering in a file name to append all address results to a log file The 'mode' parameter set to True will print the output (Note: these functions will always return a value)

Copyright

Copyright (c) 2019 The Python Packaging Authority. Released under the MIT License.