Skip to main content

Formatting utility for international postal addresses

Project description

International Address formatter

This is a address formatter that can format addresses in multiple formats that are common in different countries.

For formatting the addresses the worldwide.yml from OpenCageData address-formatting repository is used to format the address according to customs in the country that is been encoded.

API documentation

The complete project contains actually only one class:

AddressFormatter

Publicly accessible method prototypes are:

def __init__(self, config=None):
    pass

def format(self, address, country=None):
    pass

def one_line(self, address, country=None):
    pass

__init__

Initialize the address formatter

  • config: (optional) override default config file to use for the address formatter, defaults to config file included in this package

format

Format an address in the default layout used in the specified country. Return value may contain line breaks.

  • address: Dictionary that contains the address parts, see below for recognized keys
  • country: Country code of the formatting template to use

Recognized keys in address:

  • attention
  • house
  • road
  • house_number
  • postcode
  • city
  • town
  • village
  • county
  • state
  • country
  • suburb
  • city_district
  • state_district
  • state_code
  • neighbourhood

one_line

Works the same as format but returns a single line of text.

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

addressformatting-1.3.2.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

addressformatting-1.3.2-py2.py3-none-any.whl (12.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file addressformatting-1.3.2.tar.gz.

File metadata

  • Download URL: addressformatting-1.3.2.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for addressformatting-1.3.2.tar.gz
Algorithm Hash digest
SHA256 9b89154bf7371d762f96bf2733eaeafed0a51229569e059a5b6c8cd68725e400
MD5 d00d838e7c57dbce2112ea44f6682c80
BLAKE2b-256 34d72fc264670bb614f6f5dad2d1a3cb43ca364873edc27032ddd1c3cc38ffda

See more details on using hashes here.

File details

Details for the file addressformatting-1.3.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for addressformatting-1.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9c37a1d06ada17b981cead84c85f0805831fc991c2b660b2d51fc93de36bdc9e
MD5 e2efcd00a3c60720b2e1edffad727524
BLAKE2b-256 f0da1c8d3d2e93deca99e8f616f269f3f9d4e494f2d9ec7ad32491f378ecc53a

See more details on using hashes here.

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