Merge branch 'master' into typoerrors

Author: AyanSinhaMahapatra

.gitattributes

@@ -0,0 +1,3 @@
+# Ignore all Git auto CR/LF line endings conversions
+* -text
+pyproject.toml export-subst

.github/workflows/docs-ci.yml

@@ -0,0 +1,37 @@
+name: CI Documentation
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Give permission to run scripts
+        run: chmod +x ./docs/scripts/doc8_style_check.sh
+
+      - name: Install Dependencies
+        run:  pip install -e .[docs]
+
+      - name: Check Sphinx Documentation build minimally
+        working-directory: ./docs
+        run: sphinx-build -E -W source build
+
+      - name: Check for documentation style errors
+        working-directory: ./docs
+        run: ./scripts/doc8_style_check.sh
+
+

.gitignore

@@ -1,40 +1,73 @@
-*.pyc
-*.db
-.installed.cfg
-parts
-develop-eggs
-bin
-eggs
-downloads
-lib
-lib64
-build
-.project
-.pydevproject
-include
-.settings
-TAGS
-.idea
-Include
-Lib
-.env
-Procfile
-tmp
-.Python
-local.cfg
-_build
-pip-selfcheck.json
-pyvenv.cfg
-geckodriver.log
-.DS_Store
+# Python compiled files
+*.py[cod]
 
 # virtualenv and other misc bits
-.venv/
+*.egg-info
+/dist
 /build
-build/
+/bin
+/lib
+/scripts
+/Scripts
+/Lib
+/pip-selfcheck.json
+/tmp
+/venv
+.Python
+/include
+/Include
+/local
+*/local/*
+/local/
+/share/
+/tcl/
+/.eggs/
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.cache
+.coverage
+.coverage.*
+nosetests.xml
+htmlcov
+
+# Translations
+*.mo
 
 # IDEs
+.project
+.pydevproject
+.idea
+org.eclipse.core.resources.prefs
 .vscode
+.vs
 
 # Sphinx
 docs/_build
+docs/bin
+docs/build
+docs/include
+docs/Lib
+doc/pyvenv.cfg
+pyvenv.cfg
+
+# Various junk and temp files
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+*.bak
+/.cache/
+
+# pyenv
+/.python-version
+/man/
+/.pytest_cache/
+lib64
+tcl
+
+# Ignore Jupyter Notebook related temp files
+.ipynb_checkpoints/

.readthedocs.yml

@@ -0,0 +1,18 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Where the Sphinx conf.py file is located
+sphinx:
+   configuration: docs/source/conf.py
+
+# Setting the python version and doc build requirements
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

.travis.yml

@@ -0,0 +1,15 @@
+graft src
+
+include *.LICENSE
+include NOTICE
+include *.ABOUT
+include *.toml
+include *.yml
+include *.rst
+include setup.*
+include configure*
+include requirements*
+include .git*
+
+global-exclude *.py[co] __pycache__ *.*~
+

MANIFEST.in

@@ -0,0 +1,19 @@
+#
+# Copyright (c) nexB Inc. and others.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
+# ScanCode is a trademark of nexB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

NOTICE

@@ -1,24 +1,24 @@
-# AboutCode Documentation
+# AboutCode
 
-### What is AboutCode
+### What is AboutCode?
 
-AboutCode is a suite of tools to uncover data ... about software and code:
+AboutCode is a suite of tools to uncover data ... about software:
 
  - Where does it come from?
  - What is its license?
  - Is it secure, maintained, well coded?
 
-These are important questions when there are millions of free and open-source software components available on the web.
+These are important questions when there are millions of free and open source software components and packages available on the web.
 
 ### Documentation Build Status
 
-[![Build Status](https://travis-ci.org/nexB/aboutcode.svg?branch=master)](https://travis-ci.org/nexB/aboutcode)
+![Doc Build](https://github.com/nexB/aboutcode/actions/workflows/docs-ci.yml/badge.svg)
 
 ### Important Links 
 
-Our homepage lives at http://aboutcode.org
+Our homepage is at http://aboutcode.org
 
-Our documentation (in progress) lives at https://aboutcode.readthedocs.io/en/latest/ 
+Our documentation (in progress) is at https://aboutcode.readthedocs.io/en/latest/ 
 
 AboutCode Documentation Group Email Addresses:
 
@@ -30,42 +30,44 @@ AboutCode Documentation Group Email Addresses:
 
 If you want to get in touch with the team with issues other than documentation, head to the gitter channel [here](https://gitter.im/aboutcode-org/discuss).
 
+Look at our [wiki](https://github.com/nexB/aboutcode/wiki) for information about our participation
+in the GSoC and GSoD programs.
+
+We have a weekly meeting, see more details [here](https://github.com/nexB/aboutcode/wiki/MeetingMinutes).
+
 ### Projects
 
 Each AboutCode project has its own repository:
 
-- **[ScanCode Toolkit](https://github.com/nexB/scancode-toolkit)**: This is a set of code scanning tools to detect the origin and license of code and dependencies. ScanCode now uses a plug-in architecture to run a series of scan-related tools in one process flow. This is the most popular project and is used by 100's of software teams. https://github.com/nexB/scancode-toolkit . The lead maintainer is @pombredanne
+- **[ScanCode Toolkit](https://github.com/nexB/scancode-toolkit)**: a set of code scanning tools to detect the origin and license of code and dependencies. ScanCode now uses a plug-in architecture to run a series of scan-related tools in one process flow. This is the most popular project and is used by 100's of software teams . The lead maintainer is @pombredanne
+
+- **[Scancode.io](https://github.com/nexB/scancode.io)**: a web-based and
+API to run and review scans in rich scripted ScanPipe pipelines.
 
-- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)** 
-(formerly AboutCode Manager) This is a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages. https://github.com/nexB/aboutcode-manager . The lead maintainer is @majurg
+- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.
 
-- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: This is a set of command-line tools to document the provenance of your code and generate attribution notices.  AboutCode Toolkit uses small YAML files to document code provenance inside a codebase. https://github.com/nexB/aboutcode-toolkit . The lead maintainer is @chinyeungli
+- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)**: a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages. 
 
-- **[TraceCode Toolkit](https://github.com/nexB/tracecode-toolkit)**: This is a set of tools to trace files from your deployment or distribution packages back to their origin in a development codebase or repository.  The primary tool uses strace https://github.com/strace/strace/ to trace system calls on Linux and construct a build graph from syscalls to show which files are used to build a binary. We are contributors to strace. Maintained by @pombredanne
+- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: a set of command line tools to document the provenance of your code and generate attribution notices.  AboutCode Toolkit uses small yaml files to document code provenance inside a codebase. The lead maintainer is @chinyeungli
 
-- **[Conan](https://github.com/nexB/conan)**: stands for "CONtainer ANalysis" and is a tool to analyze the structure and provenance of software components in Docker images using static analysis. https://github.com/nexB/conan Maintained by @pombredanne
+- **[TraceCode Toolkit](https://github.com/nexB/tracecode-toolkit)**: a set of tools to trace files from your deployment or distribution packages back to their origin in a development codebase or repository.  The primary tool uses strace https://github.com/strace/strace/ to trace system calls on Linux and construct a build graph from syscalls to show which files are used to build a binary. We are contributors to strace. Maintained by @pombredanne
 
-- **[license-expression](https://github.com/nexB/license-expression/)**: this is a library to parse, analyze, compare and normalize SPDX and SPDX-like license expressions using a boolean logic expression engine. See https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to understand what an expression is. See https://github.com/nexB/license-expression for the code. The underlying boolean engine is live at https://github.com/bastikr/boolean.py . Both are co-maintained by @pombredanne
+- **[container-inspector](https://github.com/nexB/container-inspector)**: a tool to analyze the structure and provenance of software components in Docker images using static analysis. Maintained by @pombredanne
 
-- **ABCD, aka AboutCode Data** is a simple set of conventions to define data structures that all the AboutCode tools can understand and use to exchange data. The specification lives in this repository. ABOUT files and ScanCode toolkit data are examples of this approach. Other projects such as https://libraries.io and [OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit) are also using these conventions. 
+- **[license-expression](https://github.com/nexB/license-expression/)**: a library to parse, analyze, compare and normalize SPDX and SPDX-like license expressions using a boolean logic expression engine. See https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to understand what an expression is. See https://github.com/nexB/license-expression for the code. The underlying boolean engine is live at https://github.com/bastikr/boolean.py . Both are co-maintained by @pombredanne
 
-- **[DeltaCode](https://github.com/nexB/deltacode)** is a command line
-tool to compare scans and determine if and where there are material
-differences that affect licensing. The lead maintainer is @majurg
+- **ABCD aka AboutCode Data**: a simple set of conventions to define data structures that all the AboutCode tools can understand and use to exchange data. The details are at [AboutCode Data](https://aboutcode.readthedocs.io/en/latest/aboutcode-data/abcd.html). ABOUT files and ScanCode Toolkit data are examples of this approach. Other projects such as https://libraries.io and and [OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit) are also using these conventions. 
 
-- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging
-server-side application to collect and track known package vulnerabilities.
+- **[DeltaCode](https://github.com/nexB/deltacode)**: a command line tool to compare scans and determine if and where there are material
+differences that affect licensing. 
 
 
-We also co-started and worked closely with a few key other organizations and projects:
+We also co-started and worked closely with other FOSS orgs and projects:
 
-- [Package URL](https://github.com/package-url)  which is an emerging
-standard to reference software packages of all types with simple, readable and
+- [Package URL](https://github.com/package-url): an emerging standard to reference software packages of all types with simple, readable and
 concise URLs.
 
-- [SPDX](http://SPDX.org) aka. Software Package Data Exchange, a spec to
-document the origin and licensing of packages.
+- [SPDX](http://SPDX.org): aka. Software Package Data Exchange, a spec to document the origin and licensing of packages.
 
-- [ClearlyDefined](https://ClearlyDefined.io) to review and help FOSS projects
-improve their licensing and documentation clarity. This project is incubating
+- [ClearlyDefined](https://ClearlyDefined.io): a project to review and help FOSS projects improve their licensing and documentation clarity. This project is incubating
 with https://opensource.org