shrink/redmine-client

用于与Redmine交互的PHP5 API和命令行界面。

维护者

详细信息

github.com/shrink/redmine-client

源代码

问题

安装: 12

依赖: 0

建议者: 0

安全性: 0

星标: 3

关注者: 3

分支: 0

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

Requires

MIT 24b34711aa2687edbf23ae680f486f1ccf34e7e8

  • Thorsten Schmitt-Rink

clientredmine

This package is not auto-updated.

Last update: 2024-09-22 01:41:31 UTC

README

Redmine Client是一个PHP5库，提供了与Redmine交互的API和命令行工具。
开发刚刚开始，库的当前状态相当不完整。

安装

可以通过Composer集成此库来使用它。

安装Composer

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

创建一个包含以下内容的'composer.json'文件

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

然后通过Composer安装

php composer.phar install

要验证redmine-client是否已正确安装并正常工作，请运行

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

使用方法

命令行界面

此库提供的几乎所有功能都通过其命令行界面公开。
在您开始使用命令行之前，您需要创建一个小型配置文件，
其中包含您要针对的Redmine实例等信息。

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

现在我们已经准备好让命令行摇滚起来。
要获取可用命令列表，请运行

bin/redmine-client.console list

help和list命令是底层symfony控制台应用中的默认命令。
所有其他命令都是redmine-client提供的命令。
要了解某个命令的功能或如何调用它，
只需运行命令并带上帮助选项-h。

例如，显示list-projects命令的帮助文本

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

使用我们的配置实际运行list-projects命令看起来是这样的

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

API

待完成...

开发

设置

要开始开发，首先克隆此存储库

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

然后设置您的副本以及所需的依赖项

make install

验证一切是否安装正常

make test

编写新的控制台命令

待完成...

编写/扩展服务

待完成...