Nirjas Installation Guide

To extract comments or source code from the files, you need to install Nirjas library on your system. You can install & use Nirjas on any machine(Mac, Linux or Windows) with Python3 pre-installed.

Installing Python on Linux machines:

$ sudo apt-get install python3 python3-pip

For macOS and Windows, packages are available at python.org

To set up a Python Virtual environment, please check out Setting up a Python Virtual Environment

1. Install Nirjas using pip

Haven’t installed pip? Visit: https://pip.pypa.io/en/stable/installing/

• Update pip to the latest stable version

  pip3 install --upgrade pip

• Install Nirjas

  pip3 install -i https://test.pypi.org/simple/ Nirjas==0.0.4

2. Install Nirjas using source

• Fork the repo

• Clone on your local system

  git clone https://github.com/fossology/Nirjas.git

• Change directory

  cd Nirjas/

• Install the package

  pip install .

This will install Nirjas on your system.

• Check if Nirjas is installed correctly or get help, Run:

  nirjas -h or nirjas --help