iMake 是一个命令行工具,用于简化 Python 项目中的命令,摒弃了 Makefile 文件的可用性。
项目描述
我做
iMake是一个命令行工具,用于简化Python项目中的命令,摒弃了Makefile文件的可用性。当iMake保存键入的命令时,会向它们传递一个配置文件。
要求
要正常工作,您首先需要:
安装
$ pip install imake --user
配置
配置文件必须存在于将调用imake的位置。该文件必须命名为.imake,即隐藏在 Unix 系统上的文件。
创建文件使用命令:
imake init
创建文件后,您应该将其保留为以下结构。例子:
[build]
commands = ["python setup.py sdist"]
名称为commands的键是一个 Array 并且对于iMake必须是必需的。在此键中,您必须告知要使用主键执行的命令,在本例中为build。
带有多个命令的选项:
[build]
commands = ["rm -rf build", "rm -rf docs/_build;", "python setup.py sdist"]
您还可以在块中而不是列表中执行命令,如下使用三引号:
[clean]
commands = ["""
if [[ -d "build" ]]; then
rm -r build;
fi
rm -rf docs/_build;
rm -rf .pytest_cache;
"""]
iMake设置还有 3 个其他键,分别是description、initial_message和final_message。都是可选的。
您必须只对给定命令进行描述的关键描述。例子:
[build]
description = "This command compiles the project."
commands = ["rm -rf build", "rm -rf docs/_build;", "python setup.py sdist"]
initial_message键是在命令开始之前出现的消息。例子:
[build]
description = "This command compiles the project."
initial_message = "Starting the build ..."
commands = ["rm -rf build", "rm -rf docs/_build;", "python setup.py sdist"]
final_message键是命令完成后将出现的消息。例子:
[build]
description = "This command compiles the project."
initial_message = "Starting the build ..."
commands = ["rm -rf build", "rm -rf docs/_build;", "python setup.py sdist"]
final_message = "构建命令完成!"
注意:键的位置并不意味着什么,但值却意味着。您首先在commands键中输入的命令将首先被执行。
另一个有趣的选项是您可以使用imake在另一个命令中调用命令的执行。会是这样的:
[build]
description = "This command compiles the project."
initial_message = "Starting the build ..."
commands = ["imake clean -q", "python setup.py sdist"]
final_message = "Build command finished!"
请注意,命令imake clean -q在commands内。该-q
选项意味着静音详细模式。
使用
在文件.imake中进行设置后,执行命令imake后跟主键,在我们的示例中是build。它看起来像这样:
$ imake build
您可以运行帮助命令,imake -h
以显示您可以使用哪些命令。.imake文件中的任何配置都将显示在 中help
,减去每个命令的描述,仅当您运行--desc
or-d
选项时才会显示,例如:
$ imake build --desc
更多命令
有关更多命令信息,请使用:
$ imake -h
捐款
单击下面的图片以重定向捐赠表格:
执照
根据MIT 许可©条款,该项目可作为开源项目使用
学分
见,作者。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。