This repository aims at providing to the global IT Sustainability community a vendor-neutral, fact-based, non-judgmental and exhaustive repository of the tools and services available to assess the environmental footprint of IT components.

It defines a data model that can be used to build an inventory of the tools.

• 🗺️ Mapping of the ICT Sustainability Tools Landscape
  • Access the data
  • Repository content
  • How to configure the widget
  • Implementation
    • Architecture decisions records / ADRs
    • General design
      • Usage flow
      • Components
    • Data format
    • draft dataset
    • data validation in CI
    • Other examples of Datami widgets configration
  • Local development
    • 1. Install the mini server for local development
      • Run local server
    • 2. Configure the widget to use the local files

Visualize or edit the data set at https://boavizta.github.io/ict-sustainability-tools/

• index.html : source of the main page (published at https://boavizta.github.io/ict-sustainability-tools/)
• doc/ : documentation
  • architecture decision records: doc/adr/
• ictst
  • ictst/data
    • Main data file (CSV): ictst/data/tools.csv
    • Data validation model: ictst/data/tools.resources.yaml: Used in command line or via github actions.
  • ictst/model
    • data model used to configure the widget: ictst/model/tools.frictionless-table-schema.json
  • ictst/widget:
    • sample html page (widget): ictst/widget/tools-widget.html
    • additional fields configuration for the widget ictst/widget/tools.fields-custom-properties.json
• .github/workflows : github action to automate the data validation and publication of the page
• old-examples/: other examples of using Datami

How to configure the widget

• All ADRs

We use a Datami widget to display data and allow edition of a file stored in Github. Even if end user is not familiar with Git.

1. data is stored in GIT to benefit from historisation, review and approval workflows (and potential automatic validation of format)
2. data update can be proposed by end users in 2 ways:
   1. A web frontend that allow to view the data and propose edition => This is the preferred solution using Datami widget
   2. Pull requests directly against the data file (git) => Less preferred (mainly for maintainers of people familiar with Git)

• We store data as a csv file.
• add specific descriptors as table-format to describe and validate constraints on the fields.
• implement frictionless-ci or other automatic validation regarding format as a github action frictionless-ci | Frictionless Repository

See draft dataset

Data format (not content) is automatically validated in CI using frictionless-ci in a github action triggered on PR's.

See frictionless-ci | Frictionless Repository

# Local data validation
# See https://framework.frictionlessdata.io/docs/guides/validating-data.html

# Install frictionless cli
pip install frictionless
# 
cd ictst/data
# validate just csv _global_ structure
frictionless validate tools.csv
# validate that format of fields matches description
frictionless validate tools.resources.yaml

• A CSV file displayed without any customization old-examples/csv/csv-widget-basic.html
• A CSV file displayed with some additional constraints on fields old-examples/csv/csv-widget-with-constraints.html.
• Other examples with more complex validation rules:GitHub - demeringo/datami-tests: Testing datami widget to edit and validate csv files

To ease development and configuration of the widget, we can work with a local data set and local configuration files.

1. Run a local server to expose the data and configuration files locally (see below).
2. Modify index.html to use the local files (configure the localdev properties to true).

A mini server is written in the server.py to serve this folder's files.

To install the mini-server :

pip install --upgrade pip
python3 -m pip install --user virtualenv
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

or

sh setup.sh
source venv/bin/activate

To run the server on http://localhost:8800:

python server.py

or

sh run_server.sh

Files will be locally served on :

• http://localhost:8800/content/<path:folder_path>/<string:filename>
• http://localhost:8800/statics/<path:folder_path>/<string:filename>

Modify index.html to use the local files (configure the localdev properties to true)

{
        "title": "Tools Landscape",
        "activate": true,
        "localdev": true,
        "gitfilelocal": "http://localhost:8800/statics/ictst/data/tools.csv",
        "gitfile": "https://github.com/Boavizta/ict-sustainability-tools/blob/main/ictst/data/tools.csv",

[....]

 "schema": {
            "localdev": true,
            "filelocal": "http://localhost:8800/statics/ictst/model/tools.frictionless-table-schema.json",
            "file": "https://github.com/Boavizta/ict-sustainability-tools/blob/main/ictst/model/tools.frictionless-table-schema.json"
          },
          "fields-custom-properties": {
            "localdev": true,
            "filelocal": "http://localhost:8800/statics/ictst/widget/tools.fields-custom-properties.json",
            "file": "https://github.com/Boavizta/ict-sustainability-tools/blob/main/ictst/widget/tools.fields-custom-properties.json"
          },

💡 You can now open the local index.html in a web browser and update data or configurations. Reload the page and changes are immediately visible.