adresapi/postaladdress-sync

A command-line tool to setup and synchronize a postal code address database on the Netherlands.

dev-master 2020-02-12 22:06 UTC

This package is not auto-updated.

Last update: 2021-04-23 03:05:23 UTC


README

pipeline status coverage report Latest Version on Packagist Total Downloads Software License

Postaladdress sync is a command-line tool written in PHP. This tool can be used to setup and synchronize a postal address database of the Netherlands.

Please see supported platforms for the list of supported databases.

Install

Via Composer

composer require adresapi/postaladdress-sync

Usage

Dump SQL to create an address schema.

./bin/postaladdress setup

Add an address schema to your database. Do not use this in production.

./bin/postaladdress setup --update

Sync the address database with the latest address dump.

./bin/postaladdress sync

List all commands and help.

./bin/postaladdress

Both postaladdress setup and postaladdress sync commands will ask for a database url. If the environment variable ADRES_API_DATABASE_URL is found, then this variable will be used. This is useful for cron jobs.

Running Tests

$ composer test

Checking code style

$ composer check-style

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email gitlab@wittestier.nl instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.