Table of Contents

1. Dataset
   1. Variables
   2. Data sources
2. Prototyping
   1. Features
   2. Wireframe
3. Development
   1. Why did we pick Dash?
   2. Architecture
      1. Structure of app.py
         • Globals
         • Layout
         • Callbacks functions
   3. Visual identity guidelines
      1. Colors
         • Primary colors
         • Secondary colors
      2. Fonts
         • Primary fonts
         • Secondary fonts
      3. Logo
         • Symbol
         • Logotype
   4. How to contribute
      1. Setting up a new Git repository
      2. Adding or modifying owned files (push)
      3. Submit proposed changes to review
4. Tools that we used

Dataset

Variables

Data sources

Prototyping

Features

Wireframe

Development

Why did we pick Dash?

As we wanted to use Python to build the Dashboard we had to pick among Python dashboard libraries :

According to following benchmarck the team decided to develop the PoC with Dash

	Maturity	Popularity	Simplicity	Adaptability
Streamlit	C	A	A	C
Dash	B	A	B	B
Voila	C	C	A	C

Maturity: Based on the age of the project and how stable it is.

Popularity: Based on adoption and GitHub stars.

Simplicity: Based on how easy it is to get started using the library.

Adaptability: Based on how flexible and opinionated the library is.

Architecture

Structure of app.py

Globals

Loading libraries, style, and data

• Libraries

• Style

• Pandas DataFrame

Data prep

Global functions

Layout

Callbacks functions

Visual identity guidelines

Colors

Primary colors

Secondary colors

Fonts

Primary fonts

Secondary fonts

Logo

Symbol

Logotype

How to contribute

Setting up a new Git repository

• Clone project locally

  $ git init
  $ git clone https://github.com/dataforgoodfr/batch8_carbon4/tree/master/plateforme
  

• Ask to join our GitHub

Adding or modifying owned files (push)

When adding a new file or modifying a file that you own, do:

$ git add filename
$ git commit
$ git push

Where filename is the name of the file

Submit proposed changes to review

When modifying an existing file, if you're not its owner, you have to submit the modifications to its owner (i.e. reviewer). Ownership is distributed as follow :

Owner GitHub name	File
linetonthat	??
j-back	??
morgandavidson	??

To submit changes reviewees have to do:

$ git checkout -b pick_a_branch_name
$ git push origin pick_a_branch_name
$ git add filename
$ git commit
$ git checkout master

Then go on our GitHub,

• cilck on Pull requests,
• then on New Pull Request,
• click on compare across forks,
• select : dataforgoodfr/batch8_carbon4 | =base: master <- revieweename/batch8_carbon4 | pick_a_branch_name,
• click on create pull request
• enter GitHub reviewer name in reviewers, add title and comment,
• click on create pull request

Tools that we used

Tools	Usage
Slack	Chat
Pycharm, Jupyter	Code editing
Git, GitHub	Code storage/versioning
Python, CSS	Coding languages
Org-mode, Github, Notion	Documentation
Zoom	Meetings
dash, pandas	Python librairies
Google Slides	Wireframing