Skip to content

Latest commit

 

History

History
115 lines (90 loc) · 3.21 KB

README.md

File metadata and controls

115 lines (90 loc) · 3.21 KB
Raw

Taiga SDK

TaigaSDK is a PHP client library to work with Taiga REST API.

Installation

SDK has been written in PHP 5.5 and has no dependencies on external packages. You only have to ensure that curl and openssl extensions (that are part of standard PHP distribution) are enabled in your PHP installation.

The project attempts to comply with PSR-4 specification for autoloading classes from file paths. As a namespace prefix is 'Taiga' with base directory '{your-installation-dir}/'.

But if not using PSR-4 the installation is as easy as downloading the package and storing it under any location that will be available for including by

    require_once '{your-installation-dir}/Taiga/Autoloader.php';

in your project (see examples below).

Installation with Composer

You can use Taiga SDK library as a dependency in your project with Composer. A composer.json file is available in the repository and it has been referenced on packagist.

The installation with Composer is easy, reliable : Step 1 - Add the Taiga SDK as a dependency in your composer.json file as follow :

    "require": {
        ...
        "taiga/php-sdk": "^1.0"
    },

Step 2 - Update your dependencies with Composer

you@yourhost:/path/to/project$ php composer.phar update taiga/php-sdk

The Library has been added into your dependencies and ready to be used.

License

TaigaSDK is distributed under MIT license, see LICENSE file.

Contacts

Report bugs or suggest features using issue tracker at GitHub.

Authentication

To authenticate requests an http header called "Authorization" with this format:

Authorization: Bearer ${AUTH_TOKEN}

Follow these instructions to generate your token

Feature coverage (help wanted)

Some endpoints has been developped but there is still some couple of hours of work to have a full coverage of the API possibilities. Please, if you use this bundle and need more, share your needs or your work by creating issue or PR.

Done

  • Milestones (sprints)
  • Projects
  • Tasks
  • Users
  • User stories

Todo

  • Auth
  • Applications
  • Application Tokens
  • Resolver
  • Searches
  • User storage
  • Project templates
  • Memberships/Invitations
  • User story status
  • Points
  • User story custom attribute
  • User story custom attributes values
  • Task status
  • Task custom attribute
  • Task custom attributes values
  • Issues
  • Issue status
  • Issue types
  • Priorities
  • Severities
  • Issue custom attribute-6. Issue custom attributes values
  • Wiki pages
  • Wiki links
  • History
  • Notify policies
  • Feedback
  • Export/Import
  • Webhooks
  • Timelines
  • Locales
  • Stats

Using Symfony ?

Use the troopers/taiga-bundle to ease the API manipulation.