Skip to main content

This package implements V1 of the CDP/WWF Temperature Rating Methodology and calculates portfolio coverage for SBTi near-term targets. The portfolio coverage notebook can also be used for climate alignment assessment under the FINZ Standard.

Project description

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 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sbti_finance_tool-1.2.5.tar.gz (215.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sbti_finance_tool-1.2.5-py3-none-any.whl (223.3 kB view details)

Uploaded Python 3

File details

Details for the file sbti_finance_tool-1.2.5.tar.gz.

File metadata

  • Download URL: sbti_finance_tool-1.2.5.tar.gz
  • Upload date:
  • Size: 215.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.7 Darwin/25.3.0

File hashes

Hashes for sbti_finance_tool-1.2.5.tar.gz
Algorithm Hash digest
SHA256 7625715b28ac7729c510839e5de7d52219de2669f11f33efe0a4f231633103eb
MD5 a1cf4281e32c8e4c40ff059dcf334b44
BLAKE2b-256 bac2a8bd527d1a1f94b91f32f257d4487eaeef861dec363e6fd82df2b462f17d

See more details on using hashes here.

File details

Details for the file sbti_finance_tool-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: sbti_finance_tool-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 223.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.7 Darwin/25.3.0

File hashes

Hashes for sbti_finance_tool-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 50487056de9212e5842e8689f1ec65c5b2d5d6ab10edfa0d66883630c6e08089
MD5 01a5f551fd4924b47e4bdd83a90b3d16
BLAKE2b-256 829295c5e59fb5d3faa27e9f441a367895ca761b87bf66ac97b55abbe530e81b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page