# Installation¶

This is the complete overview of installing the Flask Monitoring Dashboard. It starts from the very basic, but it is likely that you can directly go to Installing the Flask Monitoring Dashboard Package.

## Install Python¶

You can check if you have Python installed by opening a terminal and execution the following command:

python3 --version


It should return something like ‘Python 3.6.3’, if not, you probably see something like ‘bash: python3: command not found’. In the former case, you’re ok. In the latter, you can follow this link to install Python.

## Installing a Virtual Environment (Optional)¶

Although you don’t need a Virtual Environment, it is highly recommend. See this page to install a Virtual Environment.

### Configuring the Virtual Environment (Optional)¶

If you have skipped the previous section, you can also skip this one (since it’s optional). Once you’ve installed the Virtual Environment, you need to configure it. This can be done by the following command:

virtualenv ENV


Or using the following command for Python3:

virtualenv --python=python3 ENV


### Activate the Virtual Environment (Optional)¶

This is the last part of the configuring the virtual environment. You should do this before you want to execute any python script/program. It is (again) one simple command:

source bin/activate


## Installing the Flask Monitoring Dashboard Package¶

You can install the Flask Monitoring Dashboard using the command below:

pip install flask_monitoringdashboard


Alternatively, you can install the Flask Monitoring Dashboard from Github:

git clone https://github.com/flask-dashboard/Flask-MonitoringDashboard.git
python setup.py install


## Setup the Flask Monitoring Dashboard¶

After you’ve successfully installed the package, you can use it in your code. Suppose that you’ve already a Flask application that looks like this:

from flask import Flask

...

@app.route('/')
def index():
return 'Hello World!'

if __name__ == '__main__':
app.run(debug=True)


...
dashboard.bind(app)


Together, it becomes:

from flask import Flask

dashboard.bind(app)

...

@app.route('/')
def index():
return 'Hello World!'

if __name__ == '__main__':
app.run(debug=True)


## Further configuration¶

You are now ready for using the Flask Monitoring Dashboard, and you can already view the dashboard at: dashboard.

However, the Dashboard offers many functionality which have to be configured. This is explained on the configuration page.