shrink/redmine-client

Php5 api and cli interface for interacting with redmine.

dev-master 2012-10-23 11:14 UTC

Requires

• php: >=5.3
• phpunit/phpunit: 3.7.*
• symfony/console: 2.1.*

MIT

• Thorsten Schmitt-Rink

• client
• redmine

README

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.

Installation

This library can be used by integrating it via composer.

Install composer:

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

Create a 'composer.json' file with the following content:

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

Then install via composer:

php composer.phar install

To verify that redmine-client has been correctly installed and is working, run:

./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.

config.ini

[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:

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.

example for showing the help text of the list-projects command:

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

The actually firing the list-projects command with our config looks like this:

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

API

to be done ...

Development

Setup

To get started with development first clone this repository:

git clone [e-mail]:shrink/redmine-client.git

and then setup your working copy along with the required dependencies:

make install

Verify that everything is installed ok:

make test

Writing new console commands

to be done ...

Writing/extending services

to be done ...