Code Monkey home page Code Monkey logo

jira-client's Introduction

TestMonitor Jira Client

Latest Stable Version CircleCI Travis Build Code Coverage Code Quality StyleCI License

This package provides a very basic, convenient, and unified wrapper for the PHP JIRA Rest Client.

Table of Contents

Installation

To install the client you need to require the package using composer:

$ composer require testmonitor/jira-client

Use composer's autoload:

require __DIR__.'/../vendor/autoload.php';

You're all set up now!

Usage

You'll have to instantiate the client using your credentials:

$jira = new \TestMonitor\Jira\Client('https://myjira.atlassian.net', 'username', token');

Next, you can start interacting with Jira.

Examples

Get a list of Jira projects:

$projects = $jira->projects();

Or creating an issue, for example (using type 'Bug' and project key 'PROJ'):

$issue = $jira->createIssue(new \TestMonitor\Jira\Resources\Issue([
    'summary' => 'Some issue',
    'description' => 'A better description',
    'type' => 'Bug',
]), 'PROJ');

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

License

The MIT License (MIT). Refer to the License for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.