fredguth / datadex

πŸ“¦ Serverless and local-first Open Data Platform

Home Page:https://datonic.github.io/datadex/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

D A T A D E X

A Data Platform for your community Open Data

GitHub GitHub Workflow Status GitHub Repo stars

Datadex is a fully open-source, serverless, and local-first Data Platform that improves how communities collaborate on Open Data. Datadex is not a new tool, it is a pattern showing an opinionated bridge between existing ones.

You can check real-world production implementations of the Datadex pattern working in the following repositories:

  • Gitcoin Grants Data Portal. Data hub for Gitcoin Grants data. Improves data access and empowers data scientists to conduct research and helps to guide community-driven analysis and decisions.
  • Arbitrum Grants Data Portal. Data hub for Arbitrum Grants data. Improves data access and empowers data scientists to conduct research and helps to guide community-driven analysis and decisions.
  • Filecoin Data Portal. Data hub for Filecoin data! Like Dune, but in your laptop.

πŸ’‘ Principles

  • Open: Code, standards, infrastructure, and data, are public and open source.
  • Modular and Interoperable: Each component can be replaced, extended, or removed. Works well in many environments (your laptop, in a cluster, or from the browser), can be deployed to many places (S3 + GH Pages, IPFS, ...) and integrates with multiple tools (thanks to the Arrow ecosystem). Use open tool, standards, infrastructure, and share data in accesible formats.
  • Permissionless. Don't ask, fork it and improve the models, add a new source or update any script. No API limits, just plain files.
  • Data as Code. Declarative stateless transformations tracked in git. Version your data as code! Publish and share your reusable models for others to build on top. Datasets should be both reproducible and accessible!
  • Glue: Be a bridge between tools and aproaches. E.g: Use software engineering good practices like types, tests, materialized views, and more.

πŸš€ What can you do with Datadex?

Dagster Asset_Group

βš™οΈ Setup

Datadex consists of several components and requires some setup to get started.

🐳 Docker / Dev Containers

The fastest way to start using Datadex is via VSCode Remote Containers. Once inside the develpment environment, you'll only need to run make dev to spin up the Dagster UI locally.

The development environment can also run in your browser thanks to GitHub Codespaces!

You can also build the Dockerfile image locally and run it with:

docker build -t datadex .
docker run -it -v $(pwd):/workspaces/datadex -p 3000:3000 datadex

🐍 Python Virtual Environment

Clone the repository and run the following commands from the root folder:

# Create a virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install the package and dependencies
pip install -e .[dev]

Now, you should be able to spin up Dagster UI and access it locally.

🎯 Motivation

This project started after thinking how an Open Data Protocol could look like!

πŸ‘ Acknowledgements

About

πŸ“¦ Serverless and local-first Open Data Platform

https://datonic.github.io/datadex/

License:MIT License


Languages

Language:Jupyter Notebook 96.9%Language:Python 2.5%Language:Makefile 0.3%Language:Dockerfile 0.2%