roscopecoltran/aboutcode-manager

AboutCode Manager provides an advanced visual UI to help you quickly evaluate license and other notices identified by ScanCode and record your conclusion about the effective license(s) for a component. AboutCode Manager is based on Electron and will be the primary desktop/GUI tool for using nexB’s AboutCode tools. This app works on Windows, OS X and Linux operating systems.

As detailed in the ScanCode README, ScanCode detects licenses, copyrights and other interesting information in your code and enables you to format the scan results as JSON or HTML. AboutCode Manager allows you to take the JSON-formatted scan results (HTML-formatted scans are not supported) from ScanCode and create components. By creating these components within your codebase, you are creating a software inventory of your product. The conclusions (Concluded License, Concluded Owner, etc.) you make when creating your component can then be exported to a JSON file.

Using

You can download the latest release for your operating system or build it yourself (see below). Once downloaded, you can find AboutCode-Manager under dist/AboutCode-Manager-<os>-x64-<version>.
AboutCode Manager v2 is only compatible with scans from ScanCode Toolkit v2.0.0-RC1 and above which are run with the ScanCode -i option. You need to run ScanCode with the -c (copyright detection) and -l (license detection) options in order to get copyright and license data. The -p option will detect and report package-level metadata if available.

./scancode -clipeu <input> <output_file>

We have provided a set of sample scans that you can quickly review in AboutCode Manager in order to get a sense of its functionality and the types of information captured by a scan. The samples are located at https://github.com/nexB/aboutcode-manager/tree/develop/samples.
To import a ScanCode JSON file:
- Open the File menu and select Import JSON File (keyboard shortcut: Ctrl+I or ⌘+I).
- In the dialog window that opens, navigate to the JSON file you want to import, select the file and click Open.
- You will then be prompted to choose a filename and location to save the JSON file as a SQLite database file. Add a filename, select the folder in which you want to save the SQLite database file, and click Save.
- AboutCode Manager will then create a SQLite database file from your JSON file, indicated by the status message "Creating Database ..."
- Once the process has finished, the status message will be replaced by an expandable tree displaying the root node of your SQLite database file and, to the right of the tree, a table displaying the root node attributes generated by ScanCode.

See the wiki for more documentation on how to use AboutCode Manager.

Building

You'll need Node.js (which comes with npm) installed on your computer in order to build this app. Then, from your command line:

# Clone this repository
git clone https://github.com/nexB/aboutcode-manager.git

# Go into the repository
cd aboutcode-manager

# Install dependencies and run the app
npm install

# Rebuild native Node.js modules against the version of Node.js that the app is using
./node_modules/.bin/electron-rebuild (MacOS, Linux and Git Bash on Windows)
.\node_modules\.bin\electron-rebuild.cmd (Windows except for Git Bash)

# Run the app
npm start

Release instructions

You can build a dist directory containing executables for any one of three target platforms by running ./build.sh <target> and replacing <target> with linux, darwin or win32 (for Linux, Darwin/MacOS and Windows, respectively). A build targeting Windows, for example, would look like this:

$ ./build.sh win32

After building is done, you can find AboutCode-Manager under dist/AboutCode-Manager-<os>-x64-<version>. Archives (tar.gz and .zip) are also built.

Note: A build for any of the three target platforms must be executed on the targeted platform.

Testing

Test functionality using:

$ npm test

License

Apache-2.0 with an acknowledgement required to accompany the scan output.
Public domain CC-0 for reference datasets.
Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.

See the NOTICE file for more details.

Support

If you have a question, a suggestion or find a bug, enter an issue.

For questions and chats, there is an official #aboutcode IRC channel on freenode for scancode and other related tools. You can use your favorite IRC client or use the web chat at http://webchat.freenode.net/

roscopecoltran / aboutcode-manager