artifact-py 0.1.2

工件py：工件的重新映射 < Buff行情>

注意：这是阿尔法。它可以工作，但可能有很多错误和丢失 功能。

这是在python中重新实现工件。它将成为 将其放入构建系统所必需的工件。没有功能丰富的cli，没有web ui。 只是解析和导出json/markdown/etc。

同时，这并不是一个严格的重写。这是一个重新构想和意志 可能会指导Artifact3.0的开发。

使用pip install artifact py安装。它应该在Python2.7+和3+中工作

与工件的区别

主要区别是：

• 用python而不是rust编写，以便更容易地包含在遗留构建中 系统。
• 使用新的标记属性格式 特别是此项目不依赖于任何特定的 降价实施。
• 删除.art/settings.toml，替换为 降价文件。
• CMDLine工具的大规模简化。将来可能会改进cli。
• 一些小的调整来简化工件的指定和链接方式。
  • 标记可以导出到的适当位置 更改。
  • 工件现在由头中的锚指定。按惯例 看起来像是我的规范（spc mine）{spc mine}。这个 {spc mine}是用于创建 参考文献。（spc矿山）是按照惯例的，这样人类就可以看到 头指定了一个工件。
    • 注意：anchor_txt还支持html锚<；a id="spc mine"/>；， 这在github中是必需的
  • 工件属性由一个封闭的代码块指定。请参见spc设计 例如。
  • 删除[[req foo]引用。相反，您只需对代码使用[req foo]或[@req foo]。 当您运行art export--format md-i时，它们将去掉看起来像 art foo.bar并在文档底部插入正确的链接。 （即[@req foo]：url/to/code.py
  • 通过 [[req foo.subsystem]]。只需在属性中用partof指定它们， 并用[@req foo.subsystem]链接到设计文档中的代码
  • 对Graphviz没有特殊支持。
  • 没有将工件的关系导出到标记文件本身。 在作者看来，这通常只是增加了混乱，而不是 特别有用。

总的来说，这种设计与标准的降价更为紧密地结合在一起 规范。它让人感觉更干净，并允许从 "任意"设计文档到一个具有丰富的源代码链接和 其他设计。

仍需添加的功能：

• 目前只支持一个标记文件。我也想重新想象一下 在添加更多文件之前，可以集成多个文件/etc。
• linting—当前不存在linter
• 工件json中的文本字段。它不需要任何实现细节 以后可能会添加。
• 稳定的json输出格式。它仍在不断变化。

贡献

有关出资条件，请参见许可证。

代码是用python编写的。使用以下方法进行测试：

# create the python virtualenv's locally
make init

# run tests against python3
make test3

# run all checks required to ship
make check

subparts:-artifact-settings-code-lint-tst-unittests

```yaml @
artifact:
  root_dir: ./
  code_paths:
    - src/
```

```yaml @
partof:
  - SPC-other

subparts:
  - function
  - tst-unit
```

artifact:root_dir:'./'code_paths:-artifact_py/-tests/exclude_code_paths:-tests/artifacts_only/-tests/projects/-tests/test_code.pycode_url:"https://github.com/vitiral/artifact_py/blob/master/{file}#L{line}"