Get Happiness status of your repo

Backend for repostatus. Repostatus lets you calculate the happiness status of your repository.

What we do?

We consider various parts of the repo like commit messages, comments on issues, pulls etc and run a sentiment analysis engine on the data in order to find out the happiens status.

Setup

You'll need to setup an environ variable named GITHUB_TOKEN that will contain an access token. In order to get the token, follow this article and accordingly save it to the environment.

One way to save something to environment is:

from os import environ
environ.set('GITHUB_TOKEN', '<your_token>')

Otherwise, it can also be set through the rc file, i:e zshrc, bashrc etc

Tests

For the tests, we are using pytest

If you wish to run the tests yourself, make sure you have it installed. The tests can be run by the following comand.

pytest tests/test_* --no-summary --no-header -q

Above will show the output as to how many passed or failed.

Setup Repostatus

repostatus expects a .env file in the ~/.cache/repostatus/ directory. The web API expects an .env file in the web directory.

~/.cache/repostatus/.env should be the following way:

CLIENT_ID=
CLIENT_SECRET=

Contents of the .env file required by FastAPI can be checked in the config.py file.

Running locally

If you want to run the API locally, you can do that by using a wsgi server like uvicorn.

NOTE: You need to be in the web directory in order to get the API running.

uvicorn server:app --reload

If you would like to see the docs, open the server.py file and remove the passed params while creating the FASTApi Object.

app = FastAPI() # Remove the params here

Deploying

It would be easiest to deploy the API using the Dockerfile passed. Just create a build and deploy it.

• Build the docker image docker build -t repostatus ./
• Run the docker image docker run -d --name repostatus_1 -p 5055:5055 repostatus

NOTE: The port 5055 is exposed because the Dockerfile will run uvicorn in that port. You can change it accordingly.