christianbirchler / reactant

An application to visualize the most common words used in function and method names of Java and Python repositories on GitHub.

reactant

This application is meant to collect all words in function and method names of Python and Java repositories on GitHub. For this reason I came up with the name reactant:

populaR mEthod And funCTion nAmes oN giThub

Environment Variable

To have fewer restrictions to access the GitHub API, you should generate an access token. You find in the Documentation the instructions to generate such a token.

The token is defacto your credentials to your GitHub account and should not be exposed to others. To mitigate this issue, you should store the token in an environment variable:

export GH_TOKEN=<your token>

Run reactant with Docker Compose

First, simply clone the repository:

git clone https://github.com/ChristianBirchler/reactant.git
cd reactant

If you use docker on a Mac, then docker compose is already installed and you can run the application with the following command:

docker compose build
docker compose up -d

In case you do not use a Mac, then you can install docker-compose with pip. The command looks slightly different:

docker-compose build
docker-compose up -d

The -d is optional but it will deamonize the containers but if you want to have the output of the containers in your terminal then you can leave this option flag out.

Go to your web browser on localhost:8050 to see reactant visualizing in a parameterized bar chart the top words.

Run reactant locally

In case you want to run the application locally it is worth to use a virtual environment. For managing virtual environments and dependencies in Python I use Poetry. You should go to the website and install it.

Install Dependendcies

git clone https://github.com/ChristianBirchler/reactant.git

cd reactant/miner
poetry install

cd ../visualizer
poetry install

Run reactant

cd visualizer
poetry run python src/visualizer/main.py

cd miner
poetry run python src/miner/main.py

Go to your web browser on localhost:8050 to see reactant visualizing in a parameterized bar chart the top words.