Are you new to Scancode-Toolkit?¶
This is the perfect place to start, if you are new to ScanCode-Toolkit. Have a quick look at the table of contents below, as these are the main sections you might need help on. These sections have extensive links to other important documentation pages, and make sure you go through them all.
Table of Contents¶
Try ScanCode Toolkit¶
This section is about using the Scancode-Toolkit, i.e. Performing a scan on a codebase/files to determine their license, copyrights and other information, according to your requirements.
The Scan a Codebase section helps you with configuring your virtual environment, installing Scancode and performing a basic scan, and subsequently visualize the results.
The Use ScanCode Better section helps you customize the scan according to your requirements, and better understand the advanced features you can use.
The All Tutorials/How-Tos is essentially an exhaustive list of all Tutorials and How To’s with a brief description on what they help you to achieve.
Scancode-Toolkit can be installed in 3 different methods.
Please note that different for different install methods, scan commands vary.
The basic command to perform a scan, in case of a download and configure installation (on Linux/MacOS) is:
path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
The basic usage, if Scancode is installed from
pip, or in Windows:
scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
For more information on how the Scan Command varies for Various Installation Methods/Operating Systems, refer Command Invocation Variations.
The Scan a Codebase section helps you with configuring and installing Scancode and performing a basic scan, then visualize the results.
The Use ScanCode Better section helps you customize the scan according to your requirements, and better understand advanced features.
The All Tutorials/How-Tos is an exhaustive directory of all Tutorials and How To’s with a brief description.
Before you start using Scancode¶
You need to make sure Prerequisites are installed, and a virtualenv is created.
Installation as an Application: Downloading Releases Installation via Docker: Installation as a library: via pip Installation from Source Code: Git Clone
Now you can either follow the instructions for the recommended Installation as an Application: Downloading Releases method , or run
pip install scancode-toolkit[full]like that in the Installation as a library: via pip documentation. Alternatively, you can also Installation from Source Code: Git Clone.
scancode -hto make sure Scancode was installed properly. If this shows any Error, refer the Common Installation Errors Issue for common errors.
Refer Quickstart to make sure you are using the scan command correctly.
For Windows, Refer to Installation on Windows 10 for installing easily using Releases.
Scan a Codebase¶
Once you are all set up with Scancode Toolkit, i.e. Running
scancode -h shows the
Help text, you can start scanning files or a codebase.
Refer Quickstart for commonly used scan commands, and commonly used Output Formats. (The recommended output format is
Refer this section for Extractcode Options.
How to Run a Scan is a sample tutorial for absolute beginners, to walk them through the process of running a scan. Follow this tutorial and perform a scan on the
samplefolder distributed with ScanCode, or any file/folder of your choice. Avoid advanced options, and just follow the basic instructions.
ScanCode generates output files with scan results. You can visualize
JSONresult files using Scancode Workbench. Follow this tutorial How to Visualize Scan results to visualize the scan results.
Use ScanCode Better¶
Go through all the options in the page All Available Options, to know about Scancode Command Line options. You can then modify the Scan according to your requirements.
The Tutorials are:
The How-To’s are:
You can see all Scancode Toolkit versions on the GitHub release page.
Read the CHANGELOG for more information on specific releases.
If you want to use/test a specific version of Scancode Toolkit, you can follow the instructions in Installation from Source Code: Git Clone docs.
Learn more about ScanCode Toolkit¶
Here we give an introduction on the Scancode Toolkit Documentation Sections that can help you to learn more about Scancode Toolkit.
This section contains a complete guide to ScanCode Toolkit Command Line options, i.e. What the command-line options are, how different options affect the scan and outputs, how to use these options and examples of their use cases.
Now this section has three types of pages:
The Synopsis page and the How to Run a Scan page as summaries.
An exhaustive list of all Command Line Options at All Available Options
All the other pages detailing the Type of Options
Note that the page for one type of options also has a short list of all the options detailed on that page in the beginning. The All Available Options page just has all of them together, and also the extractcode options.
How Scancode Works¶
This section has documentation on How does ScanCode detect licenses?.
Plugins are an integral part of ScanCode Toolkit in the sense they are used to easily extend Scancode capabilities, and developers can code their own plugins according to their requirements.
This section has documentation on:
All Plugin Tutorials
If you are looking to Contribute to Scancode Toolkit, this is where you start.
Also refer the Contribution page here.
For more Project Ideas, refer Contributor Project Ideas (old).
Before committing your work, make sure you have read this post on Writing good Commit Messages.
If you haven’t contributed to Scancode Toolkit refer Good First Issues.
To determine where to contribute, you can refer:
ScanCode Toolkit tracks issues via the GitHub Issue tracker
Broad milestones for upcoming versions are also maintained.
And documentation related to contributing code can be referred at Contributing to Code Development.
Good First Issues¶
A good first issue means it’s recommended for people who haven’t contributed to Scancode Toolkit before.
Refer the detailed documentation for Good First Issue.
Important Links for Good First issues are also compiled.
What you should understand before Solving a Good First Issue
A first timers only issue means we’ve worked to make it more legible to folks who either haven’t contributed to our codebase before, or even folks who haven’t contributed to open source before.
Refer the detailed documentation for First Timers Only.
Add new Functionality/Enhancement to ScanCode¶
There are two main paths you can follow to add a new functionality to Scancode. They are:
Add the functionality to Scancode itself.
Add plugins if the functionality is very much application dependent.
Refer enhancement issues for the first type of enhancements. If you want to add a plugin to implement the functionality, refer all the Plugin Tutorials.
Update our Documentation¶
Maintaining a comprehensive, accurate, updated and effective documentation is very important as that directly affects the acceptability of Scancode Toolkit.
To contribute to Scancode Toolkit Documentation, first refer the Contributing to the Documentation section.
The sections in this page cover the following:
Continuous Integration system for the Documentation
You can contribute to the following Open Issues on documentation.
Refer Something Missing? to report Documentation Errors or to request Improvements.
Also, consider contributing to other Aboutcode Project Documentations, as they need more support.
Participate in GSoC/GSoD¶
If you want to participate in any of the two programs:
Keep an eye out for Application Timelines.
Solve multiple of these Good First Issue to demonstrate your skills, and improve your chances of selection.
Refer the Projects Ideas list for details on tentative projects.
Remain active in Gitter and talk with the organization mentors well ahead of the deadlines.
Select projects according to your skills and finalize project proposals.
Discuss your proposals extensively with corresponding mentors.
Apply for the Programs well before the Deadline.