Skip to content

Repository files navigation

Dummy Address Data (DAD) Python Library

Dummy Address Data (DAD) - Retrieve real addresses from all around the world. (Python Client Library)

Build StatusCoverage StatusPyPiLicence

Showcase

The DAD Python library is the perfect companion to quickly bootstrap address data in your application. DAD provides real addresses from all over the world with a consistent data structure so you can spend less time looking up addresses and address rules and more time coding.

Install

# Install tool
pip3 install dad_tool
# Install locally
just install

Address Data

Address objects will look like the sample below. The data type of each field on an address object is a string. A list of addresses is an array of json objects.

Attempts have been made to verify addresses and ensure that street1, city, state, and zip are present on all records. Some lists may be shorter than others to avoid complexity or because of a lack of accurate data.

The following files can be found in the data directory.

Australia

LocationsTag
Victoria AreaAU_VT

Canada

LocationsTag
BC AreaCA_BC

China

LocationsTag
Beijing AreaCN_BJ
Hong Kong - Wan Chai AreaCN_HK

Europe

LocationsTag
Germany - Wesel AreaEU_DE
Spain - CountrywideEU_ES
France - Paris AreaEU_FR
United Kingdom - England AreaEU_UK

Mexico

LocationsTag
Mexico - Mexico City AreaMX_MX

United States

LocationsTag
Arizona - Gilbert AreaUS_AZ
California - Anaheim AreaUS_CA
Idaho - Boise AreaUS_ID
Kansas - Barton CountyUS_KS
Nevada - Lincoln AreaUS_NV
New York - Rochester AreaUS_NY
Oregon - Portland AreaUS_OR
Texas - Austin AreaUS_TX
Utah - Provo AreaUS_UT
Washington - Spokane AreaUS_WA

Usage

importdad_tool# Grab a random UT addressaddress=dad_tool.random_address('US_UT')
print(address)
# Alternatively, grab the entire UT listaddresses=dad_tool.list_addresses('US_UT')
print(addresses)
# Get the list of all ISO country codesiso_data=dad_tool.list_iso_country_codes()
print(iso_data)

Sample Address Object

A sample address object will look like the following:

{
"street1": "231 N 1200 W",
"street2": "UNIT 104",
"city": "OREM",
"state": "UT",
"zip": "84057",
"country": "US"
}

Sample ISO Country Object

{
"country": "United States of America",
"alpha_2_code": "US",
"alpha_3_code": "USA"
}

Development

# To setup the `DAD` git submodule
just setup-dad
# Get a comprehensive list of development tools
just --list

Attribution

  • Addresses provided by DAD.

About

Dummy Address Data (DAD) - Retrieve real addresses from all around the world. (Python Client Library)

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages