DevLake Jupyter Playground

DevLake offers an abundance of data for exploration. This playground contains a basic set-up to interact with the data using Jupyter Notebooks and Pandas.

How to play

Prerequisites

• Python >= 3.12
• Poetry
• Access to a DevLake database
• Optional: An IDE or plugin that supports running Jupyter Notebooks directly (e.g. Visual Studio Code)

Usage

1. Have a local clone of this repository.
2. Run poetry install in the root directory.
3. Either:
   • navigate to the notebooks directory and run the jupyter server poetry run jupyter notebook
   • navigate to one of the notebook files (.ipynb) in the notebooks directory from your IDE directly
4. Make sure the notebook uses the virtual environment created by poetry.
5. Configure your database URL in the notebook code.
6. Run the notebook.
7. Start exploring the data in your own notebooks!

Create your own Jupyter Notebook

A good starting point for creating a new notebook is template.ipynb. It contains the basic steps you need to go from query to output.

To define a query, use the Domain Layer Schema to get an overview of the available tables and fields.

Use Pandas api to organize, transform, and analyze the query results.

Predefined notebooks and utilities

A notebook might offer a valuable perspective on the data not available within the capabilities of a Grafana dashboard. In this case, it's worthwhile to contribute this notebook to the community as a predefined notebook, e.g., process_analysis.ipynb (it depends on graphviz for its visualization).

The same goes for utility methods with, for example, predefined Pandas data transformations offering an interesting view on the data.

Contributing

Please check the contributing guidelines.