datmachine/datmachine

Client for Datmachine API

1.0.1 2014-09-13 14:32 UTC

Requires

• matthewfl/restful: 1.0.3
• nategood/httpful: 0.2.3

Requires (Dev)

• phpunit/phpunit: 3.7.*
• twig/twig: 1.*

MIT

• Datmachine

• api
• analytics

README

Business Analytics for SaaS

The design of this library was heavily influenced by Httpful.

Requirements

• PHP >= 5.3 with cURL
• RESTful >= 1.0.x
• Httpful >= 0.2.x

Issues

Please use appropriately tagged github issues to request features or report bugs.

Installation

You can install using composer or from source. Note that Datmachine is PSR-0 compliant:

Composer

If you don't have Composer install it:

$ curl -s https://getcomposer.org/installer | php

Require datmachine in your composer.json:

{
    "require": {
        "datmachine/datmachine": "1.*"
    }
}

Refresh your dependencies:

$ php composer.phar update

Then make sure to require the autoloader and initialize all:

<?php
require(__DIR__ . '/vendor/autoload.php');

\Httpful\Bootstrap::init();
\RESTful\Bootstrap::init();
\Datmachine\Bootstrap::init();
...

Source

Download Httpful source:

$ curl -s -L -o httpful.zip https://github.com/nategood/httpful/zipball/v0.2.3;
$ unzip httpful.zip; mv nategood-httpful* httpful; rm httpful.zip

Download RESTful source:

$ curl -s -L -o restful.zip https://github.com/matthewfl/restful/zipball/master;
$ unzip restful.zip; mv matthewfl-restful* restful; rm restful.zip

Download the Datmachine source:

$ curl -s -L -o datmachine.zip https://github.com/datmachine/datmachine-php/zipball/master
$ unzip datmachine.zip; mv datmachine-datmachine-php-* datmachine; rm datmachine.zip

And then require all bootstrap files:

<?php
require(__DIR__ . "/httpful/bootstrap.php")
require(__DIR__ . "/restful/bootstrap.php")
require(__DIR__ . "/datmachine/bootstrap.php")

\Httpful\Bootstrap::init();
\RESTful\Bootstrap::init();
\Datmachine\Bootstrap::init();
...

Quickstart

Refer to the Quickstart guide in the Datmachine Documentation.

Usage

See https://datmachine.co/docs/api for guides and documentation.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Write your code and tests
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new pull request