请访问https://sciencebasedtargets.github.io/SBTi-finance-tool/以获取完整文档

如果您有任何其他问题或评论，请发送邮件至：finance@sciencebasedtargets.org

SBTi温度一致性工具

本软件包帮助企业及金融机构评估当前目标、承诺以及投资和贷款组合的温度一致性，并利用这些信息为SBTi官方验证的目标制定计划。

此工具可以作为独立Python包、REST API或简单Web应用使用，后者提供了一个简单的API皮肤。因此，SBTi工具包适用于三种使用方式。

• 用户可以在其代码库中集成Python包。
• 该工具可作为微服务（容器化REST API）集成到任何IT基础设施中（在云端或本地）。
• 作为Web应用，通过简单的用户界面提供功能。

以下图表提供了工具包不同部分的概览。

+-------------------------------------------------+
|   UI     : Simple user interface on top of API  |
|   Install: via dockerhub                        |
|            docker.io/sbti/ui:latest             |
|                                                 |
| +-----------------------------------------+     |
| | REST API: Dockerized FastAPI/NGINX      |     |
| | Source : github.com/OFBDABV/SBTi_api    |     |
| | Install: via source or dockerhub        |     |
| |          docker.io/sbti/sbti/api:latest |     |
| |                                         |     |
| | +---------------------------------+     |     |
| | |                                 |     |     |
| | |Core   : Python Module           |     |     |
| | |Source : github.com/ScienceBasedTargets/     |
| | |               SBTi-finance-tool |     |     |
| | |Install: via source or PyPi      |     |     |
| | |                                 |     |     |
| | +---------------------------------+     |     |
| +-----------------------------------------+     |
+-------------------------------------------------+

如上图所示，API依赖于Python仓库，同样，UI需要API后端。这些依赖关系已在Docker文件中脚本化。

此仓库仅包含Python模块。如果您想使用REST API，请参阅此仓库或Dockerhub上的相同仓库。

结构

本项目的文件夹结构如下所示。

.
├── .github                 # Github specific files (Github Actions workflows)
├── app                     # FastAPI app files for the API endpoints
├── docs                    # Documentation files (Sphinx)
├── config                  # Config files for the Docker container
├── SBTi                    # The main Python package for the temperature alignment tool
└── test                    # Automated unit tests for the SBTi package (Nose2 tests)

安装

可以使用PIP安装SBTi包。如果您想本地安装，请使用以下命令。对于测试或生产，请参阅部署部分以获取更多信息。

pip install -e .

要安装PyPi上的最新稳定版本，请运行

pip install sbti-finance-tool

开发

为了设置带有所有依赖项的本地开发环境，请安装poetry并运行

poetry install

这将创建项目文件夹下的虚拟环境.venv。

测试

每个类都应该进行单元测试。单元测试使用Nose2框架编写。setup.py脚本应已安装Nose2，因此现在可以按以下方式运行测试

nose2 -v

发布到PyPi

当对main进行任何更改并合并时，应将包发布到PyPi。

更新包

1. 根据语义版本化原则在pyproject.toml中增加版本号
2. 运行poetry build
3. 运行poetry publish
4. 检查包是否成功上传

初始设置

• 在PyPi上创建账户