Skip to main content

Dummy Address Data (DAD) - Real addresses from all around the world.

Project description

Dummy Address Data (DAD) Python Library

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

Build Status Coverage Status PyPi Licence

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
make 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

Locations Tag
Victoria Area AU_VT

Canada

Locations Tag
BC Area CA_BC

China

Locations Tag
Beijing Area CN_BJ
Hong Kong - Wan Chai Area CN_HK

Europe

Locations Tag
Germany - Wesel Area EU_DE
Spain - Countrywide EU_ES
France - Paris Area EU_FR
United Kingdom - England Area EU_UK

Mexico

Locations Tag
Mexico - Mexico City Area MX_MX

United States

Locations Tag
Arizona - Gilbert Area US_AZ
California - Anaheim Area US_CA
Idaho - Boise Area US_ID
Kansas - Barton County US_KS
Nevada - Lincoln Area US_NV
New York - Rochester Area US_NY
Oregon - Portland Area US_OR
Texas - Austin Area US_TX
Utah - Provo Area US_UT
Washington - Spokane Area US_WA

Usage

import dad_tool

# Grab a random UT address
address = dad_tool.random_address('US_UT')
print(address)

# Alternatively, grab the entire UT list
addresses = dad_tool.list_addresses('US_UT')
print(addresses)

# Get the list of all ISO country codes
iso_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
git submodule init && git submodule update --remote

# Get a comprehensive list of development tools
make help

Attribution

  • Addresses provided by DAD.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dad-tool-0.3.0.tar.gz (29.8 kB view hashes)

Uploaded Source

Built Distribution

dad_tool-0.3.0-py3-none-any.whl (43.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page