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

Requires

• php: ^7.2
• ext-curl: *
• ext-zip: *
• doctrine/orm: ^2.7
• league/csv: ^9.5
• league/pipeline: ^1.0
• php-curl-class/php-curl-class: ^8.6
• symfony/console: ^5.0

Requires (Dev)

• phpmd/phpmd: ^2.8
• phpstan/phpstan: ^0.12.4
• phpstan/phpstan-strict-rules: ^0.12.1
• phpunit/phpunit: ^8.5
• squizlabs/php_codesniffer: ^3.5
• vimeo/psalm: ^3.8

MIT

• WitteStier

README

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 [e-mail] instead of using the issue tracker.

Credits

• WitteStier
• All Contributors

License

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