Skip to main content

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

Project description

SBTi Temperature Alignment tool

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 either as a standalone Python package, a REST API or as a simple webapp which provides a simple skin on the API. So, the SBTi toolkit caters for three types of usage:

  • Users can integrate the Python package in their codebase
  • The tool can be included as a Microservice (containerised REST API) in any IT infrastructure (in the cloud or on premise)
  • As an webapp, exposing the functionality with a simple user interface.

To following diagram provides an overview of the different parts of the toolkit:

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

As shown above the API is dependent on the Python Repo, in the same way the UI requires the API backend. These dependencies are scripted in the Docker files

This repository only contains the Python module. If you'd like to use the REST API, please refer to this repository or the same repository on Dockerhub.

Structure

The folder structure for this project is as follows:

.
├── .github                 # Github specific files (Github Actions workflows)
├── app                     # Flask 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)

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

Development

For development purposes, install the SBTi package using the following command:

pip install -e .[dev]

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

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-0.4.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

SBTi-0.4-py3-none-any.whl (298.1 kB view details)

Uploaded Python 3

File details

Details for the file SBTi-0.4.tar.gz.

File metadata

  • Download URL: SBTi-0.4.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for SBTi-0.4.tar.gz
Algorithm Hash digest
SHA256 045591bfe8adff0d463fb8a184f001e344fd7352d41668454e3d611f314ee095
MD5 58afa22e05b80471d5cb76f1b9631590
BLAKE2b-256 99873dadf811e6a00cf500f57ad1cb8dae24d57a9a5c752789bc1262aac6ec5c

See more details on using hashes here.

File details

Details for the file SBTi-0.4-py3-none-any.whl.

File metadata

  • Download URL: SBTi-0.4-py3-none-any.whl
  • Upload date:
  • Size: 298.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for SBTi-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 00af7b64325851a1636e9d8f0ab6c58d4dc6c6be6f198414a6a02098eb00a485
MD5 71efce8283ff0ee42a2141f3c9f99088
BLAKE2b-256 94d6a9c765d96228382c0367b4e5419a7f8b4eafbb839d24b85411984d2a1940

See more details on using hashes here.

Supported by

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