kevinem/nonprofit-explorer-laravel

ProPublica provides an application programming interface (API) to the search engine and database that powers Nonprofit Explorer.

0.1.0 2017-01-06 22:05 UTC

Requires

• illuminate/support: ^5.3
• kevinem/nonprofit-explorer-php: ^0.1.0

Requires (Dev)

• mockery/mockery: ^0.9.7
• phpunit/phpunit: ^5.7

MIT

• Kevin Em

README

ProPublica provides an application programming interface (API) to the search engine and database that powers Nonprofit Explorer.

Installation

To install, use composer:

composer require kevinem/nonprofit-explorer-laravel

Documentation

https://projects.propublica.org/nonprofits/api

Configuration

After installing the package, register the KevinEm\NonprofitExplorerLaravel\NonprofitExplorerServiceProvider in your config/app.php configuration file:

'providers' => [
    // Other service providers...

    KevinEm\NonprofitExplorerLaravel\NonprofitExplorerServiceProvider::class,
],

Also, you can add the NonprofitExplorer facade to the aliases array in your config/app.php configuration file:

'aliases' => [
    // Other facades...
    
    'NonprofitExplorer' => KevinEm\NonprofitExplorerLaravel\Facades\NonprofitExplorer::class,
],

Example Usage

NonprofitExplorer::search(['q' => 'propublica']);

NonprofitExplorer::organization(142007220);

License

The MIT License (MIT) Copyright (c) 2016 Kevin Em

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.