This repository contains some basic infrastructure to set up Grimorie Lab analysis. By basic I mean, just getting data from some repositories, storing them in a running elasticsearch, and visualizing them using kibana.
If you want a more complete environment, go for Mordred.
Some features from the whole Grimoire Lab environment are not provided by this basic infraestructure:
- Sorting Hat related features: merging people multiple identities to unify people profiles and managing people affiliation information to show activity by organization.
- Some backends might be missing.
- No data auto-update.
It contains a docker-compose.yml basic file to set up an elasticsearch and kibana listening in default ports (9200 and 5601).
Run it with:
$ docker-compose -d up
It also contains a Dockerfile to build a docker image to run the analysis. If you want to test it, just build it with:
$ docker build -t grimoirelab-basic-infra .
There is already an image in Docker Hub.
Change the settings/data-sources.yml file to fit your needs, or produce a new one.
Remember: You need an elasticsearch up and listening in the host and port defined in data-sources.yml file.
If you have an elasticsearch running in localhost, in its default port (9200), run the grimoirelab-basic-infra as:
$ docker run -v /absolute-path-to/data-sources.yml:/settings/data-sources.yml --net=host -ti jsmanrique/grimoirelab-basic-infra
- git (commits)
- GitHub repositories (commits, github issues and pull requests)
- GitHub organizations (commits, github issues and pull requests) (It doesn't support GitHub users, by now)
- Meetup
- Discourse
I am not a 100% technical person, so I am self-learning Python, Docker and many other things to create this. The aim for this project is to have a simple way to set up and run a simple Grimoire Lab analysis for some demo purposes. I am sure you can find better ways to do this, so any help is welcome. There are bugs, and many improvements can be done. Feel free to submit them.
If you wanna help on the Grimoire Lab side, check its repositories. It's 100% free, libre, open source software.
Bitergia folks are working on training materials for Grimoire Lab. Worth reading. Contributions are welcome too ;-)
GPL v3