Atarashi Installation Guide

You need to install Atarashi on your own system to try and test it out. We recommend you to set up a separate Python virtual environment for the same.

If you don't know how to set up a Python Virtual environment, please check out Setting up a Python Virtual Environment

---

You can Install Atarashi in two ways:

1. Install Atarashi using pip

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

• Update pip to the latest stable version

pip install --upgrade pip

• Install third-party code comment dependency for Atarashi

pip install code_comment@git+https://github.com/amanjain97/code_comment@master#egg=code_comment

• Install Atarashi

pip install atarashi

---

2. Install Atarashi using Source

• Fork the repo
• Clone on your local system

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

• Change directory

cd atarashi/

• Install third-party code comment dependency for Atarashi

pip install code_comment@git+https://github.com/amanjain97/code_comment@master#egg=code_comment

• Install the package

pip install .

This will download all dependencies required and trigger build as well.

• The build will generate 3 new files in your current directory

1. data/Ngram_keywords.json
2. licenses/.csv
3. licenses/processedList.csv

These files will be placed to their appropriate places by the install script.

Installing dependencies

If you just want to install the required dependencies on your system, run the following command:

pip install -r requirements.txt

Build the package (optional)

$ python3 setup.py build

Check if Atarashi is installed correctly or to get help

atarashi -h or atarashi --help

---