通过api为habitica编写python脚本
scriptabit的Python项目详细描述
自述
==
Habitica的Python脚本和场景。
…图片::https://img.shields.io/travis/dc23/scriptabit.svg
:目标:https://travis ci.org/dc23/scriptabit
:alt:travis ci
…图片::https://readthedocs.org/projects/scriptabit/badge/?version=latest
:目标:http://scriptabit.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://img.shields.io/pypi/l/scriptabit.svg
:目标:https://opensource.org/licenses/apache-2.0
:alt:apache 2.0 license
…图片::https://img.shields.io/pypi/v/scriptabit.svg
:目标:https://pypi.python.org/pypi/scriptabit
:alt:pypi
…图片::https://img.shields.io/pypi/pyversions/scriptabit.svg
:目标:https://www.python.org
*免费软件:apache 2.0
*主页:https://github.com/dc23/scriptabit
*文档:https://scriptabit.readthedocs.org
*版本:2.1.2
**注意**github针对bug和功能请求发出问题,但是
大多数任务和功能规划都是在一个私有的
`trello<;https://trello.com>;``板中执行的。可根据要求提供访问权限。
然后使用以下命令进行升级:
pip install--upgrade scriptabit
+++++++++++++++https://habitica.com//options/settings/api>;`.
该文件应具有典型的ini文件结构,具有以下部分::
[habitica]
userid=
apikey=
并且可以将要使用的节名
作为命令行参数提供。
如果您还没有`.auth.cfg'文件,则在首次运行scriptabit时将创建默认值。然后,您可以填写您的帐户值。
输入habitica凭据后,使用`-sud`
命令(简称`--show user data`)对其进行测试:
scriptabit-sud
您应该看到打印到控制台的字符
数据摘要。
**请注意,您的api密钥实际上是habitica
帐户的密码。**您应该确保.auth.cfg文件受到保护,并且
永远不要与其他人共享密钥。在Linux和相关系统上,可以按如下方式设置权限:
chmod 600.auth.cfg
…_ trello-credentials:
trello-credentials
++++++++++++++++您需要将trello
凭据添加到.auth.cfg文件中,如下所示::
[trello]
api key=
apicret=
token=
token secret=
首次运行trello插件时,您的授权令牌和令牌密钥将通过
交互过程获得。必须先将API密钥和API机密保存到.auth.cfg文件中,然后才能获取令牌和令牌机密。
。_用法:
usage
----
`scriptabit`是一个命令行应用程序。可以通过运行以下命令获得可用命令的帮助:
$scriptabit--help
操作包括:
-`-sud`:显示用户数据。
-`-hp n`:将用户运行状况设置为n
-`-mp n`:将用户的法力值设置为n
-`-xp n`:将体验值设置为n
-`-gp n`:将gold设置为n
-`-ls`:列出可用的插件。
`~/.config/scriptabit/`。可以编辑这些选项以更改默认选项。您可以通过删除文件(下次运行时将重新创建这些文件)恢复到安装默认值。
有关特定功能的详细说明,请参见:ref:`detailed usage`部分。
大多数内置插件都定义了一个方便的命令行
应用程序名:
-`sb banking`是'scriptabit--运行banking'的快捷方式
-`sb csv`是'scriptabit--运行csv任务'的快捷方式
-`sb health`是'scriptabit--运行health'效果的快捷方式
-` sb pets是"scriptabit--run pet\u care"的快捷方式
-`sb trello'是"scriptabit--run trello"的快捷方式
-`sb tasks'是"scriptabit--run tasks"的快捷方式
所有其他命令行参数都与运行"scriptabit"时相同。
notification panel
++++++++++++br/>
当在更新循环中有一些函数运行时,这很有用。
可以使用命令行上的"use notification panel"参数或通过在
scriptabit.cfg文件中设置值来控制此面板的使用。设置为0或False以抑制面板。
++这个行为可以通过`--tags``选项来控制。它接受以逗号分隔的标记列表。
若要禁用标记的使用,请将选项设置为空字符串:``--tags""``
writing plugins
----
首次运行"scriptabit"时,将在主目录中创建
。由于初始化顺序问题,无法在命令行上指定此目录位置(处理
命令行参数之前需要定位插件目录,以便插件有机会添加其他
参数)。如果定义了"scriptabit_user_plugin_dir"环境变量,
则将使用此位置而不是默认位置。
**请注意,插件数据文件也可以写入用户插件目录**
所有插件都应子类为"iplugin"类。有关可用方法的详细信息,请参阅api
文档。
==
Habitica的Python脚本和场景。
…图片::https://img.shields.io/travis/dc23/scriptabit.svg
:目标:https://travis ci.org/dc23/scriptabit
:alt:travis ci
…图片::https://readthedocs.org/projects/scriptabit/badge/?version=latest
:目标:http://scriptabit.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://img.shields.io/pypi/l/scriptabit.svg
:目标:https://opensource.org/licenses/apache-2.0
:alt:apache 2.0 license
…图片::https://img.shields.io/pypi/v/scriptabit.svg
:目标:https://pypi.python.org/pypi/scriptabit
:alt:pypi
…图片::https://img.shields.io/pypi/pyversions/scriptabit.svg
:目标:https://www.python.org
*免费软件:apache 2.0
*主页:https://github.com/dc23/scriptabit
*文档:https://scriptabit.readthedocs.org
*版本:2.1.2
**注意**github针对bug和功能请求发出问题,但是
大多数任务和功能规划都是在一个私有的
`trello<;https://trello.com>;``板中执行的。可根据要求提供访问权限。
然后使用以下命令进行升级:
pip install--upgrade scriptabit
该文件应具有典型的ini文件结构,具有以下部分::
[habitica]
userid=
apikey=
并且可以将要使用的节名
作为命令行参数提供。
如果您还没有`.auth.cfg'文件,则在首次运行scriptabit时将创建默认值。然后,您可以填写您的帐户值。
输入habitica凭据后,使用`-sud`
命令(简称`--show user data`)对其进行测试:
scriptabit-sud
您应该看到打印到控制台的字符
数据摘要。
**请注意,您的api密钥实际上是habitica
帐户的密码。**您应该确保.auth.cfg文件受到保护,并且
永远不要与其他人共享密钥。在Linux和相关系统上,可以按如下方式设置权限:
chmod 600.auth.cfg
…_ trello-credentials:
trello-credentials
++++++++++++++++您需要将trello
凭据添加到.auth.cfg文件中,如下所示::
[trello]
api key=
apicret=
token=
token secret=
首次运行trello插件时,您的授权令牌和令牌密钥将通过
交互过程获得。必须先将API密钥和API机密保存到.auth.cfg文件中,然后才能获取令牌和令牌机密。
。_用法:
usage
----
`scriptabit`是一个命令行应用程序。可以通过运行以下命令获得可用命令的帮助:
$scriptabit--help
操作包括:
-`-sud`:显示用户数据。
-`-hp n`:将用户运行状况设置为n
-`-mp n`:将用户的法力值设置为n
-`-xp n`:将体验值设置为n
-`-gp n`:将gold设置为n
-`-ls`:列出可用的插件。
`~/.config/scriptabit/`。可以编辑这些选项以更改默认选项。您可以通过删除文件(下次运行时将重新创建这些文件)恢复到安装默认值。
有关特定功能的详细说明,请参见:ref:`detailed usage`部分。
大多数内置插件都定义了一个方便的命令行
应用程序名:
-`sb banking`是'scriptabit--运行banking'的快捷方式
-`sb csv`是'scriptabit--运行csv任务'的快捷方式
-`sb health`是'scriptabit--运行health'效果的快捷方式
-` sb pets是"scriptabit--run pet\u care"的快捷方式
-`sb trello'是"scriptabit--run trello"的快捷方式
-`sb tasks'是"scriptabit--run tasks"的快捷方式
所有其他命令行参数都与运行"scriptabit"时相同。
notification panel
++++++++++++br/>
当在更新循环中有一些函数运行时,这很有用。
可以使用命令行上的"use notification panel"参数或通过在
scriptabit.cfg文件中设置值来控制此面板的使用。设置为0或False以抑制面板。
若要禁用标记的使用,请将选项设置为空字符串:``--tags""``
writing plugins
----
首次运行"scriptabit"时,将在主目录中创建
。由于初始化顺序问题,无法在命令行上指定此目录位置(处理
命令行参数之前需要定位插件目录,以便插件有机会添加其他
参数)。如果定义了"scriptabit_user_plugin_dir"环境变量,
则将使用此位置而不是默认位置。
**请注意,插件数据文件也可以写入用户插件目录**
所有插件都应子类为"iplugin"类。有关可用方法的详细信息,请参阅api
文档。