Skip to content

Latest commit

 

History

History
73 lines (37 loc) · 1.82 KB

INSTALL.md

File metadata and controls

73 lines (37 loc) · 1.82 KB
Raw

Installing the Software Assessment Framework (SAF)

Requirements

SAF has been developed using Python 3.5, it uses language features and syntax not supported in Python 2.x

Installation

Use of a Python Virtual Environment venv is suggested

Ubuntu Linux

  1. Setup and activate the Virtual Environment

$ virtualenv -p python3 venv

$ source venv/bin/activate

  1. Clone the SAF GitHub repository:

$ git clone https://github.com/softwaresaved/software-assessment-framework.git

  1. Install the prerequisite Python packages as described in requirement.txt:

$ cd software-assessment-framework

$ pip install -r requirements.txt

MacOS

The installation instructions for MacOS are the same as those for Ubuntu Linux.

Windows

  1. Install python3.6, anaconda and git-bash - ensure path environment variables are installed during anaconda installation.

  2. setup and activate the virtual environment

$ virtualenv venv

$ source venv/Scripts/activate

  1. clone the SAF GitHub repository

$ git clone https://github.com/UserName/software-assessment-framework.git

  1. install the prerequisite python packages as described in requirement.txt

$ cd software-assessment-framework

$ pip install -r requirements.txt

Using conda instead of venv

If you use conda to manage virtual environments, replace step 1 as follows:

  1. Set up and activate the conda virtual environment

$ conda create --name saf python=3.6

$ source activate saf

Configuration

Make a copy of config.py.template as config.py Some operations employ the GitHub API, and require a GitHub Personal Access Token to be generated and inserted into config.py

Running

run.py starts the web app, which will be accessible on http://localhost:5000

python run.py