跳转到主要内容

Dokku风格的命令行界面

项目描述

注意: 此项目处于开发初期。您可以添加命令(见下文)来帮助。

https://badge.fury.io/py/dokku-client.png https://pypip.in/d/dokku-client/badge.png

安装

pip install dokku-client

配置

您可以在命令行上指定Dokku主机与应用,但您可能会发现设置以下环境变量更方便。

export DOKKU_HOST=ubuntu@myserver.com
export DOKKU_APP=my-app-name

在虚拟环境的postactivate钩子中设置这些变量可能很有用。

用法

安装完成后,使用方法简单

dokku-client help

产生

Client for Dokku

usage:
    dokku-client <command> [<args>...]
    dokku-client help

global options:
    -H <host>, --host=<host>      Host address
    -a <app>, --app=<app>         App name

full list of available commands:

    help       Show this help message
    configget  Set one or more config options
    configset  Set one or more config options in the app's ENV file
    prompt     Open a prompt
    restart    Restart the container

See 'git help <command>' for more information on a specific command.

贡献新命令

Dokku-client允许任何开发者挂钩额外的命令。这是通过dokku-client内部使用的相同机制完成的,即由setuptools提供的入口点。

首先,创建一个Python包。您可能有自己的首选方式来做这件事,但我用seed

mkdir dokku-client-mycommand
cd dokku-client-mycommand
pip install seed
seed create
ls

其次,创建一个扩展dokku_client.BaseCommand并实现方法main(args)的类。同时,类的顶部文档块将由docopt用于解析任何命令行参数,因此请确保包含它。请参阅提示命令的示例。

第三,在新的setup.py文件中,指定您的新类作为入口点。

entry_points={
    'dokku_client.commands': [
        'mycommand = dokku_client_mycommand.mycommand:MyCommand',
    ],
}

运行setup.py以初始化新入口点。

# Run in develop mode, so files will not be copied away.
# You can continue to edit your code as usual
python setup.py develop

现在,您应该会发现新的命令在dokku-client中可用,运行dokku-client help以检查。

完成后,您可以使用seed release --initial将您的包发布到PyPi。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

dokku-client-0.2.3.tar.gz (6.7 kB 查看哈希值)

上传时间 源代码

由以下组织支持