Home
Atarashi scans for license statements in open-source software.
✨ 🍰 ✨
Atarashi is an exploratory project aimed at researching and Implementing the best license scanning agent that can later be integrated with FOSSology.
The main goal is to detect one or more license/s in a text-file/source-file. For this, we consider a collection of all the available license text files. The idea of detection is to actually determine the particular licensing of a file(which license it belongs to) rather than computing the number of licenses used.
Therefore, we have a text file f and a set of licenses L, containing license texts l_i. (Obviously markdown cannot do subscript/index notation at normal letters.
In order to determine license relevant texts and also particular licenses, there will be:
- A collection of all words W found in A l_i e L (allquantor ... element of)
- A collection of all words V used on normal English language, taken from some data material from the Internet
Open source is the free distribution of source code available for redistribution and modification as per the restrictions provided by the source code’s original author. Unlike other software and programs, FOSS has different definitions. The source code is freely available on the open-source platforms and makes it prone to the ill use of a person’s original work.
Read more about open source: https://opensource.org/
Here the OSS license comes into play. It restricts the usage, distribution, and modification of the author’s work according to his will. There are licenses that are specially designed to deal with these kinds of works known as Open Source Licenses.
Atarashi follows a non-rule based approach and works standalone as a command-line license scanner and can be integrated with the FOSSology’s original software.
Atarashi advantage is an improved precision which provides an easier way to add new license text and reference. Currently, it implements multiple text statistics and information retrieval algorithms.
New to FOSSology and open source licensing?
We’ve compiled a list of helpful resources to get you started.
Please visit https://github.com/fossology/fossology/wiki/New-at-FOSSology%2C-You-Could-...
Want to Know more about our Agents
- Have a look at Our Agents: Briefly Explained
- Generate Documentation
- Contribute to Atarashi
- Reporting Bugs
- Coding Style
- Git Commit Conventions we follow
- Evaluate Agent
Atarashi is licensed under the GNU General Public License v2.0
The references and documentation style is taken directly from FOSSology’s wiki
I thank all the developers, contributors and maintainers of FOSSology as well as Atarashi for their valuable contribution to the project.