结合yaml数据集和基于jinja2的模板的工具。
datareport的Python项目详细描述
记者
This tool helps in gathering and formatting of data into a report. The tool reporter.py basically combines YAML data files with Jinja2-based templates. In this way simple markup versions of your report can be produced. Together with a format converter like [Pandoc](http://pandoc.org) the produced output can then be converted to various target formats (HTML, PDF, …).
To keep a good overview which data is acquired for different parts of the report, it is probably a good step to automate the whole workflow with a tool like [snakemake](https://snakemake.readthedocs.io/en/stable/) or other make-like tools.
#安装
The fastest way to install datareport is to use your systems tools:
pip install datareport要使用最新的测试版本，请签出test.pypi服务器：
pip install –index-url https://test.pypi.org/simple datareport
##要求
All required packages are listed in environment.yaml. In case you installed datareport via a package management system like pip, anaconda, miniconda, … all dependencies should already be installed automatically.
#入门
For easing your first steps with datareport a small set of [documented examples](examples/README.md) can be found in the examples/ folder. The README file gives an overview and you can find the right place to start.
进一步阅读
For designing reports you need to know about the templating language and since you will want to use some automation for the reporting process, also a make-like tool is very helpful. Look at the excellent snakemake for that!
- [Jinja2](http://jinja.pocoo.org/docs/2.10/) (→ [templating language](http://jinja.pocoo.org/docs/2.10/templates/))
- [Snakemake](https://pypi.org/project/snakemake/) (→ [writing rules](https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html))
As data inputs you can use different formats. For understanding the details about each format you find a lot of information on the web, especially:
- YAML (→ [specification](http://yaml.org/spec/)) and the [ruamel.yaml](https://yaml.readthedocs.io/en/latest/basicuse.html) package.
- JSON (→ [specification](https://json.org/))
#开发数据报告
Contributions are very welcome! Write issues for feature requests or directly file a pull-request with your contribution and/or contact me directly!
##测试
This project uses the [PyTest framework](https://docs.pytest.org/en/latest/) with tests defined in the [tests/](tests/) sudirectory. It is added into the setuptools config, so that it can be run with
python setup.py test这将自动测试临时打包的版本
或者，您可以手动运行pytest 详细信息]（https://docs.pytest.org/en/latest/usage.html）。
##发布
The release workflow is mostly automated and is in the [release/](release/) folder.
欢迎加入QQ群-->： 979659372
