Skip to content

OpenCageData/perl-Geo-Address-Formatter

Repository files navigation

Geo::Address::Formatter

A Perl module to take structured address data and format it according to the various global/country rules.

The module runs against a set of templates and test cases from the address-formatting project.

Build status

Build StatusCPAN Coverage Status Mastodon Follow

Usage

For docs please see the Geo::Address::Formatter page on search.metacpan.org or perldoc Geo::Address::Formatter.

Installation

To install into your Perl environment you can use the following command:

$ cpan Geo::Address::Formatter

or (recommended) use cpanm

The address-formatting repository is added as a git submodule. It is versioned, that means it won't automatically update when you run git pull. To point it to a newer version of the configuration run

  1. git submodule init
  2. git submodule update

This will give you the templates as versions with this repository. To fetch the latest templates available use git submodule foreach git pull origin master

See also: http://git-scm.com/book/en/Git-Tools-Submodules

To submit new countries/territories please see the details in the address-formatting repository, this module just processes the templates

DEVELOPMENT

# first install Dist::Zilla
dzil clean

# running the test-suite
dzil test --author

# don't forget to increase the version number in dist.ini and CHANGES file
dzil build

# git push, upload to CPAN
dzil release

COPYRIGHT AND LICENCE

Copyright OpenCage GmbH [email protected]

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10 or, at your option, any later version of Perl 5 you may have available.

Who is OpenCage GmbH?

We run a worldwide geocoding API and geosearch service based on open data. Learn more about us.

We also organize Geomob, a series of regular meetups for location based service creators, where we do our best to highlight geoinnovation. If you like geo stuff, you will probably enjoy the Geomob podcast.