Computes features from source code data and developers metadata
Go Makefile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
db
features
util
.gitignore
.travis.yml
AUTHORS
LICENSE
Makefile
README.md
featscomp.conf.sample
featscomp.go

README.md

featscomp: compute DevMine features

Build Status GoDoc GoWalker

featscomp computes 'features', as defined by the DevMine project and inserts them into the database.

Installation

To install featscomp, run this command in a terminal, assuming Go is installed:

go get github.com/DevMine/featscomp

Or you can download a binary for your platform from the DevMine project's downloads page.

You also need to setup a PostgreSQL database. Look at the README file in the db sub-folder for details.

Usage and configuration

Copy featscomp.conf.sample to featscomp.conf and edit it according to you needs. It has two sections, one to configure access to the database, the other to specify which feature you would like to compute:

  • database: allows you to configure access to your PostgreSQL database.
    • hostname: hostname of the machine.
    • port: PostgreSQL port.
    • username: PostgreSQL user that has access to the database.
    • password: password of the database user.
    • dbname: database name.
    • ssl_mode: takes any of these 4 values: "disable", "require", "verify-ca", "verify-null". Refer to PostgreSQL documentation for details.
  • features: allows you to specify which feature to compute.

Once configuring is done, simply run featscomp and give it a configuration file as argument:

featscomp featscomp.conf