atarashi.atarashii module

Copyright 2018 Aman Jain (amanjain5221@gmail.com)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

atarashi.atarashii.atarashii_runner(inputFile, processedLicense, agent_name, similarity='CosineSim', ngramJsonLoc=None, verbose=None)[source]
Parameters:
  • inputFile – Input File for scanning of license
  • processedLicense – Processed License List (CSV) path (Default path already provided)
  • agent_name – Specify the agent that you want to use for scanning
  • similarity – Specify the similarity type to be used for the particular agent
  • ngramJsonLoc – Specify N-Gram Json File location
  • verbose – Specify if verbose mode is on or not (Default is Off/ None)
Returns:

Returns the array of JSON with scan results

shortname Short name of the license
sim_type Type of similarity from which the result is generated
sim_score Similarity score for the algorithm used mentioned above
desc Description/ comments for the similarity measure
atarashi.atarashii.main()[source]

Calls atarashii_runner for each file in the folder/ repository specified by user Prints the Input file path and the JSON output from atarashii_runner