Metadata-Version: 2.1
Name: addressformatting
Version: 1.0.2
Summary: Formatting utility for international postal addresses
Home-page: https://github.com/dunkelstern/international_address_formatter
Author: Johannes Schriewer
Author-email: hallo@dunkelstern.de
License: BSD
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](https://github.com/OpenCageData/address-formatting) 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:
        
        ```python
        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.
        
Keywords: address formatting,international
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
