You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source Scanner is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
13
+
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source Scanner is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)[](https://fosslight.org/fosslight-guide-en/scanner/1_source.html)
14
14
</p>
15
15
16
16
```note
@@ -23,86 +23,18 @@ Use Source Code Scanner and process the scanner results.
23
23
24
24
[sc]: https://github.com/nexB/scancode-toolkit
25
25
26
-
## Contents
27
26
28
-
-[Prerequisite](#-prerequisite)
29
-
-[How to install](#-how-to-install)
30
-
-[How to run](#-how-to-run)
31
-
-[Result](#-result)
32
-
-[How to report issue](#-how-to-report-issue)
33
-
-[License](#-license)
27
+
## π User Guide
34
28
29
+
We describe the user guide in the FOSSLight guide page.
30
+
Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/1_source.html) for more information on how to install and run it.
35
31
36
-
## π Prerequisite
37
32
38
-
FOSSLight Source Scanner needs a Python 3.6+.
39
-
For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build].
Please see the [CONTRIBUTING guide](https://fosslight.org/fosslight-guide-en/learn/1_contribution.html) for how to contribute.
42
37
43
-
## π How to install
44
-
45
-
It can be installed using pip3. It is recommended to install it in the [python 3.6 + virtualenv](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html) environment.
46
-
47
-
```
48
-
$ pip3 install fosslight_source
49
-
```
50
-
51
-
## π How to run
52
-
53
-
There are two commands for FOSSLight Source Scanner.
54
-
55
-
### 1. fosslight_source
56
-
After executing ScanCode, the source code scanner, print the FOSSLight Report.
57
-
58
-
| Parameter | Argument | Description |
59
-
| ------------- | ------------- | ------------- |
60
-
| h | None | Print help message. |
61
-
| p | String | Path to detect source. |
62
-
| j | None | As an output, the result of executing ScanCode in json format other than FOSSLight Report is additionally generated. |
63
-
| o | String | Output file name without file extension. |
64
-
65
-
#### Ex. Print result to FOSSLight Report and json file
66
-
```
67
-
$ fosslight_source -p /home/source_path -j
68
-
```
69
-
70
-
### 2. fosslight_convert
71
-
Converts the result of executing ScanCode in json format into FOSSLight Report format.
72
-
73
-
| Parameter | Argument | Description |
74
-
| ------------- | ------------- | ------------- |
75
-
| h | None | Print help message. |
76
-
| p | String | Path of ScanCode json files. |
77
-
| o | String | Output file name without file extension. |
78
-
79
-
#### Ex. Converting scancode json result to FOSSLight report
- FOSSLight-Report_[datetime].xlsx : FOSSLight Source Scanner result in OSS Report format.
96
-
- FOSSLight-Report_[datetime].csv : FOSSLight Source Scanner result in csv format. (Except Windows)
97
-
- fosslight_src_log_[datetime].txt : The execution log.
98
-
- scancode_[datetime].json : The ScanCode result in case of -j option.
99
-
100
-
101
-
## π How to report issue
102
-
103
-
Please report any ideas or bugs to improve by creating an issue in [Git Repository][repo]. Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
0 commit comments