bugherd/bugherd

BugHerd API Libraries for PHP

, _(*1)

BugHerd API PHP Library

PHP library for interacting with the BugHerd API (http://www.bugherd.com/api), _(*2)

Usage

1. Install the library using one of the methods below., _(*3)

2. Ensure the library files are loadable from a PSR-0 compatible autoloader., _(*4)

3. Initialize the API library by passing the account email address and password., _(*5)

   php $api = new BugHerd_Api('email@address.com`, 'password');, _(*6)

4. Call any of the available API methods., _(*7)

   php $api = new BugHerd_Api('email@address.com`, 'password'); $projects = $api->listProjects();, _(*8)

A list of available api methods can be found at http://www.bugherd.com/api, _(*9)

Full usage documentation can be found at https://github.com/spekkionu/bugherd/wiki/Usage, _(*10)

Installation

Install from zip

1. Go to https://github.com/spekkionu/bugherd
2. Click the ZIP button.
3. Extract to desired directory.

Installing with Git

1. Clone the repository sh $ git clone git://github.com/spekkionu/bugherd.git

Installing with Composer

1. Download the composer.phar executable or use the installer., _(*11)

   sh $ curl -s http://getcomposer.org/installer | php, _(*12)

2. Create a composer.json with the following requirements, _(*13)

   json { "require": { "bugherd/bugherd": "*" } }, _(*14)

3. Run Composer: php composer.phar install, _(*15)

Running Tests

1. Copy or rename sample.config.ini as config.ini inside the tests directory., _(*16)

2. Edit the tests/config.ini file to add the email address and password of the account to test with., _(*17)

3. Run phpunit on tests/BugHerd_ApiTest.php, _(*18)

Warning This will run tests on the account. Test projects will be created to run tests on and removed as the tests complete. If a test fails the test project may fail to be deleted and must be removed maually., _(*19)

License

BugHerd API PHP library is licensed under the New BSD License - http://www.opensource.org/licenses/bsd-license.php, _(*20)