library laravel-datasets

bluora/laravel-datasets

Provides console commands, models and migration scripts to syncronize datasets.

``` ___ _ _ / \ __ _ | |_ __ _ ___ ___ | |_ ___ / /\ // || __|/ _ |/ | / _ | __|/ __| / ///| (| || || (| |__ | __/| |_ __ \ /,' __,| _|__,||/ _| __||___/, <sub>(*1)</sub>

Provides console commands, models and migration scripts to syncronize datasets into your applications database. Datasets are defined by array based configuration whilst advanced manipulation or data retrieval can be done through inline closures.

[![Latest Stable Version](https://poser.pugx.org/hnhdigital-os/laravel-datasets/v/stable.svg)](https://packagist.org/packages/hnhdigital-os/laravel-datasets) [![Total Downloads](https://poser.pugx.org/hnhdigital-os/laravel-datasets/downloads.svg)](https://packagist.org/packages/hnhdigital-os/laravel-datasets) [![Latest Unstable Version](https://poser.pugx.org/hnhdigital-os/laravel-datasets/v/unstable.svg)](https://packagist.org/packages/hnhdigital-os/laravel-datasets) [![Built for Laravel](https://img.shields.io/badge/Built_for-Laravel-green.svg)](https://laravel.com/) [![License](https://poser.pugx.org/hnhdigital-os/laravel-datasets/license.svg)](https://packagist.org/packages/hnhdigital-os/laravel-datasets)

[![Build Status](https://travis-ci.org/hnhdigital-os/laravel-datasets.svg?branch=master)](https://travis-ci.org/hnhdigital-os/laravel-datasets) [![StyleCI](https://styleci.io/repos/77605381/shield?branch=master)](https://styleci.io/repos/77605381) [![Test Coverage](https://codeclimate.com/github/hnhdigital-os/laravel-datasets/badges/coverage.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-datasets/coverage) [![Issue Count](https://codeclimate.com/github/hnhdigital-os/laravel-datasets/badges/issue_count.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-datasets) [![Code Climate](https://codeclimate.com/github/hnhdigital-os/laravel-datasets/badges/gpa.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-datasets) 

This package has been developed by H&H|Digital, an Australian botique developer. Visit us at [hnh.digital](http://hnh.digital).

## Install

Via composer:

`$ composer require hnhdigital-os/laravel-datasets ~1.0`

This package's service provider will autoload from Laravel 5.5.

To enable the service provider in versions prior to Laravel 5.4, edit the config/app.php:

```php
    'providers' => [
        ...
        HnhDigital\Datasets\ServiceProvider::class,
        ...
    ];

Available datasets

DATA.OKFN Collection (hnhdigital-os/laravel-datasets-okfn)

NOTE: This collection is included by default when you install this package., <sub>(*2)</sub>

• Country Codes
• Country Population
• Country Population (current)
• Language Codes

Australia Collection (hnhdigital-os/laravel-datasets-australia)

• Banks
• BSB
• Postcodes

Need a dataset? Request it, Pull Request it, or build it. Use the DATA.OKFN as a template., <sub>(*3)</sub>

If you do setup your own collection, please let us know so that we can put it on the official list., <sub>(*4)</sub>

Usage

List

$ php artisan datasets:list, <sub>(*5)</sub>

Lists all the available dataset collections available to be installed., <sub>(*6)</sub>

Install

$ php artisan datasets:install {dataset}, <sub>(*7)</sub>

Installs the specified dataset. This will create the table in the database and do an initial sync of the data., <sub>(*8)</sub>

Migrate

$ php artisan datasets:migrate {dataset}, <sub>(*9)</sub>

Setup the table in the database. This will create the migration file in the right spot and add to the migrations table., <sub>(*10)</sub>

Use this console command when scheduling dataset update., <sub>(*11)</sub>

Sync

$ php artisan datasets:sync {dataset}, <sub>(*12)</sub>

Downloads the data and insert/updates the existing records., <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*14)</sub>

Credits

• Rocco Howard
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>