shrink/redmine-client

Php5 api and cli interface for interacting with redmine.

Redmine Client

Redmine Client is a php5 library that provides an api and cli-tool for interacting with Redmine.
Development has just started and the current state of the lib is quite incomplete., _(*1)

Installation

This library can be used by integrating it via composer., _(*2)

Install composer:, _(*3)

curl -s http://getcomposer.org/installer | php

Create a 'composer.json' file with the following content:, _(*4)

{
    "require": {
        "shrink/redmine-client": "*"
    },
    "minimum-stability": "dev"
}

Then install via composer:, _(*5)

php composer.phar install

To verify that redmine-client has been correctly installed and is working, run:, _(*6)

./vendor/bin/redmine-client.make test

Usage

Command Line Interface

Almost all functionality provided by this library is exposed by it's cli.
Before you can start using the cli you need to create a small config file,
where you put information on the redmine instance you are targetting etc., _(*7)

config.ini, _(*8)

[redmine]
user=clark-kent
password=look-ma-i-can-haz-fly
baseUrl=https://some.redmine.project.base_url/

[cacheSettings]
type=memcache
host=localhost
port=11211

Now we're ready to get the cli rocking.
For a list of available commands run:, _(*9)

bin/redmine-client.console list

The help and the list commands are defaults from the underlying symfony console app.
All others are redmine-client provided commands.
To find out what a certain command does or how to call it
simply run the command together with the help option -h., _(*10)

example for showing the help text of the list-projects command:, _(*11)

bin/redmine-client.console list-projects -h

The actually firing the list-projects command with our config looks like this:, _(*12)

bin/redmine-client.console list-projects config.ini

API

to be done ..., _(*13)

Development

Setup

To get started with development first clone this repository:, _(*14)

git clone git@github.com:shrink/redmine-client.git

and then setup your working copy along with the required dependencies:, _(*15)

make install

Verify that everything is installed ok:, _(*16)

make test

Writing new console commands

to be done ..., _(*17)

Writing/extending services

to be done ..., _(*18)