Skip to main content

Visit https://sciencebasedtargets.github.io/SBTi-finance-tool/ for the full documentation

If you have any additional questions or comments send a mail to: financialinstitutions@sciencebasedtargets.org

SBTi Temperature Alignment tool

Note: This tool implements Version 1.0 (PDF in this repo) of the CDP/WWF Temperature Rating Methodology, for setting and reporting on SBTi Financial Institutions Near-Term Targets. For Version 1.5 of the methodology, please refer to the CDP-WWF Temperature Scoring Methodology.

This package helps companies and financial institutions to assess the temperature alignment of current targets, commitments, and investment and lending portfolios, and to use this information to develop targets for official validation by the SBTi.

This tool can be used as a standalone Python package or as a containerised REST API.

  • Python package: Integrate directly into your codebase or run via Jupyter notebooks
  • REST API: Deploy as a microservice using the SBTi Finance Tool API

This repository contains the Python package. For the REST API, see the API repository.

Structure

The folder structure for this project is as follows:

.
├── .github                 # Github specific files (Github Actions workflows)
├── docs                    # Documentation files (Sphinx)
├── examples                # Jupyter notebook examples
├── SBTi                    # The main Python package for the temperature alignment tool
└── test                    # Automated unit tests for the SBTi package (Nose2 tests)

Installation

The SBTi package may be installed using PIP. If you'd like to install it locally use the following command. For testing or production please see the deployment section for further instructions

pip install -e .

For installing the latest stable release in PyPi run:

pip install sbti-finance-tool

Development

To set up the local dev environment with all dependencies, install poetry and run

poetry install

This will create a virtual environment inside the project folder under .venv.

SBTi Companies Taking Action (CTA) Data

The tool supports multiple formats of the SBTi CTA file:

  • Per-company format (default, recommended): One row per company with aggregated target status
  • Per-target format: Multiple rows per company with detailed target information
  • Legacy format: Original Title Case column format

The tool automatically detects and handles all formats, defaulting to the per-company format for consistency.

Testing

Each class should be unit tested. The unit tests are written using the Nose2 framework. The setup.py script should have already installed Nose2, so now you may run the tests as follows:

nose2 -v

Publish to PyPi

The package should be published to PyPi when any changes to main are merged.

Update package

  1. bump version in pyproject.toml based on semantic versioning principles
  2. run poetry build
  3. run poetry publish
  4. check whether package has been successfully uploaded

Initial Setup

  • Create account on PyPi

Metadata

Release files for sbti-finance-tool 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sbti-finance-tool 1.3.1
File Size Uploaded
sbti_finance_tool-1.3.1.tar.gz 2.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sbti-finance-tool 1.3.1
File Interpreter ABI Platform
sbti_finance_tool-1.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 4.4 MB

Release files / sbti_finance_tool-1.3.1.tar.gz

Download URL sbti_finance_tool-1.3.1.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
3631d911e82c0582f5630db61c54d796ff57dc02f271f34532e0f0ef70140b11
BLAKE2b-256 checksum
How to use checksums
490aa22b9ca99bdc16a3cbbe30f8a8ccd902efa08794fc8a6b67843968bab6d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.7 Darwin/25.5.0

Release files / sbti_finance_tool-1.3.1-py3-none-any.whl

Download URL sbti_finance_tool-1.3.1-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f650a00091cc5b8d7d7b4233663c8b11d5a47f5e4275318805a8a31064ff5afb
BLAKE2b-256 checksum
How to use checksums
a5fc10d2fa9debd38dfe3026533abe69e8df4562ed104412a086fb06455deb0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.7 Darwin/25.5.0

Release history Release notifications | RSS feed

This release

1.3.1 This release

2 release files

1.3.0

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

1 release file

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page