Welcome to Atarashi’s documentation!¶

Atarashi¶

This is a Google Summer of Code Project.
New License Scanner Project Which Should be Integrated with FOSSology but also Work Independently.

Requirements¶

Python >= v3.5
pip

Steps for Installation¶

Build (optional)¶

$ python setup.py build
Build will generate 3 new files in your current directory
1. data/Ngram_keywords.json
2. licenses/<SPDX-version>.csv
3. licenses/processedList.csv
These files will be placed to their appropriate places by the install script. ### Install
# python setup.py install
In install folder, make the “atarashi-install.sh” executable
Run <./atarashi-install.sh>
pip install -r <pathto/requirements.txt>

How to run¶

Get the help by running atarashi -h or atarashi --help

Example¶

Running DLD agent

atarashi -a DLD /path/to/file.c
Running wordFrequencySimilarity agent

atarashi -a wordFrequencySimilarity /path/to/file.c
Running tfidf agent
- With Cosine similarity
  
  atarashi -a tfidf /path/to/file.c
  
  atarashi -a tfidf -s CosineSim /path/to/file.c
- With Score similarity
  
  atarashi -a tfidf -s ScoreSim /path/to/file.c
Running Ngram agent
- With Cosine similarity
  
  atarashi -a Ngram /path/to/file.c
  
  atarashi -a Ngram -s CosineSim /path/to/file.c
- With Dice similarity
  
  atarashi -a Ngram -s DiceSim /path/to/file.c
- With Bigram Cosine similarity
  
  atarashi -a Ngram -s BigramCosineSim /path/to/file.c
Running in verbose mode

atarashi -a DLD -v /path/to/file.c
Running with custom CSVs and JSONs
- Please reffer to the build instructions to get the CSV and JSON understandable by atarashi.
- atarashi -a DLD -l /path/to/processedList.csv /path/to/file.c
- atarashi -a Ngram -l /path/to/processedList.csv -j /path/to/ngram.json /path/to/file.c

Test¶

Run imtihaan (meaning Exam in Hindi) with the name of the Agent.
eg. python atarashi/imtihaan.py /path/to/processedList.csv <DLD|tfidf|Ngram> <testfile>
See python atarashi/imtihaan.py --help for more

Creating Debian packages¶

Install dependencies .. code-block:: guess

# apt-get install python3-setuptools python3-all debhelper # pip install stdeb
Create Debian packages .. code-block:: guess

$ python3 setup.py –command-packages=stdeb.command bdist_deb
Locate the files under deb_dist

How to generate the documentation manually using sphinx¶

Go to project directory ‘atarashi’.

#. Install Sphinx and m2r pip install sphinx m2r (Since this project is based on python so pip is already installed). #.

Initialise docs/ directory with sphinx-quickstart
```bash
mkdir docs
cd docs/
sphinx-quickstart
```
Root path for the documentation [.]: .

Separate source and build directories (y/n) [n]: n

autodoc: automatically insert docstrings from modules (y/n) [n]: y

intersphinx: link between Sphinx documentation of different projects (y/n) [n]: y

Else use the default option

Setup the conf.py and include README.md

Enable the following lines and change the insert path:

import os
import sys
sys.path.insert(0, os.path.abspath('../'))

Enable m2r to insert .md files in Sphinx documentation:

[...]
extensions = [
  ...
  'm2r',
]
[...]
source_suffix = ['.rst', '.md']

Include README.md by editing index.rst

.. toctree::
    [...]
    readme

.. mdinclude:: ../README.md

Auto-generate the .rst files in docs/source which will be used to generate documentation
```
cd docs/
sphinx-apidoc -o source/ ../atarashi
```
cd docs
make html

This will generate file in docs/_build/html. Go to: index.html

How to generate the documentation using setuptools¶

Build atarashi (or install sphinx using pip install sphinx m2r)
```
python3 setup.py build
```

Refresh source .rst files

sphinx-apidoc -Pe -o source/ ../atarashi

#. Check for new modules files (if any) and add :private-members: under your new .. automodule::. #.

Generate the docs
python3 setup.py build_sphinx

Check python3 setup.py build_sphinx --help for more.

You will get the files under build/sphinx/html.

You can change the theme of the documentation by changing html_theme in docs/config.py file. You can choose from {‘alabaster’, ‘classic’, ‘sphinxdoc’, ‘scrolls’, ‘agogo’, ‘traditional’, ‘nature’, ‘haiku’, ‘pyramid’, ‘bizstyle’}

Reference