Merge remote-tracking branch 'upstream/develop' into detect-build-gradle

Author: pombredanne

.gitattributes

@@ -1,6 +1,6 @@
-# make sure end of lines are always lf
-*		text eol=lf
-*.bat		text eol=crlf
+# Ignore all Git auto CR/LF line endings conversions
+* -text
+pyproject.toml export-subst
 
 # data in the tests should be kept as is
 **/data/** binary

.github/workflows/ci-about-files.yml

@@ -24,16 +24,16 @@ jobs:
         run: ./configure --dev
 
       - name: Activate VirtualEnv
-        run: source bin/activate
+        run: source venv/bin/activate
 
       #- name: Check About Files in thirdparty
-      #  run: ./bin/about check thirdparty/
+      #  run: ./venv/bin/about check thirdparty/
 
       - name: Check About Files in thirdparty
-        run: ./bin/about check src/
+        run: ./venv/bin/about check src/
 
       - name: Check About Files in thirdparty
-        run: ./bin/about check etc/
+        run: ./venv/bin/about check etc/
 
       - name: Check About Files in thirdparty
-        run: ./bin/about check scancode-toolkit.ABOUT
+        run: ./venv/bin/about check scancode-toolkit.ABOUT

.gitignore

@@ -4,11 +4,12 @@
 # Python compiled files
 *.py[cod]
 
-# do not commit thriparty cache of wheels
+# do not commit thirdparty cache of wheels
 /thirdparty
 
 # virtualenv and other misc bits
 /src/*.egg-info
+*.egg-info
 /dist
 /build
 /bin
@@ -18,6 +19,7 @@
 /Lib
 /pip-selfcheck.json
 /tmp
+/venv
 .Python
 /include
 /Include
@@ -83,6 +85,9 @@ lib64
 tcl
 /.env
 
+# Ignore Jupyter Notebook related temp files
+.ipynb_checkpoints/
+
 *.orig
 /release*
 /00-*.txt

.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

AUTHORS.rst

@@ -33,11 +33,13 @@ The following organizations or individuals have contributed to ScanCode:
 - Horie Issei @is2ei
 - James Ward @jamesward
 - Jelmer Vernooij @jelmer
+- Kunal Chhabra @kunalchhabra37
 - Jillian Daguil @jdaguil
 - Jiri Popelka @jpopelka
 - Jiyeong Seok @dd-jy
 - Johannes Najjar @joshovi
 - Jose Nazario @paralax
+- Kevin Ji @KevinJi22
 - Lemo Shi @lemoshi
 - Li Ha @linexb
 - Mankaran Singh @MankaranSingh

CHANGELOG.rst

@@ -1,16 +1,20 @@
 Changelog
 =========
 
+
 31.0.0 (next, roadmap)
 -----------------------
 
-
-
 Important API changes:
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Main package API function `get_package_infos` is now deprecated, and is replaced by
-  `get_package_manifests`.
+- Adopt the new skeleton from https://github.com/nexB/skeleton
+  The key change is the location of the virtual environment. It used to be
+  created at the root of the scancode-toolkit directory. Its is now created
+  instead under the ``venv`` subdirectory.
+
+- Main package API function `get_package_infos` is now deprecated, and is
+  replaced by `get_package_manifests`.
 
 - The data structure of the JSON output has changed for copyrights, authors
   and holders: we now use proper name for attributes and not a generic "value".
@@ -142,6 +146,12 @@ Changes:
 - add top-level attribute `packages`.
 
 
+Documentation Update
+~~~~~~~~~~~~~~~~~~~~~~~~
+- Various documentations have been updated to reflects API changes and
+  correct minor documentation issues.
+
+
 30.1.0 - 2021-09-25
 --------------------
 

CONTRIBUTING.rst

@@ -48,9 +48,9 @@ For other questions, discussions, and chats, we have:
   Gitter also has an IRC bridge at https://irc.gitter.im/
   This is the main place where we chat and meet.
 
-- an official #aboutcode IRC channel on freenode (server chat.freenode.net)
+- an official #aboutcode IRC channel on liberachat (server web.libera.chat)
   for scancode and other related tools. You can use your
-  favorite IRC client or use the web chat at https://webchat.freenode.net/ .
+  favorite IRC client or use the web chat at https://web.libera.chat/?#aboutcode .
   This is a busy place with a lot of CI and commit notifications that makes
   actual chat sometimes difficult!
 
@@ -142,15 +142,15 @@ To set up ScanCode for local development:
 
    Then activate the virtual environment::
 
-        source bin/activate
+        source venv/bin/activate
 
         or
 
-        . bin/activate
+        . venv/bin/activate
 
    On Windows use::
 
-        Scripts\activate
+        venv\Scripts\activate
 
    When you create a new terminal/shell to work on ScanCode rerun the activate step.
 

INSTALL.rst

@@ -47,7 +47,7 @@ Advanced installation: pip install a Python PyPI package
 
 - Create a virtual environment for Python 3.x and activate it::
 
-    virtualenv -p python3 venv-scancode && source venv-scancode/bin/activate
+    virtualenv -p python3 venv && source venv/bin/activate
 
 - Run ``pip install scancode-toolkit[full]``
 

MANIFEST.in

@@ -1,4 +1,5 @@
 graft src
+
 graft thirdparty
 recursive-include etc configure.py
 graft etc/thirdparty
@@ -7,19 +8,20 @@ recursive-include etc/thirdparty *
 include *.LICENSE
 include NOTICE
 include *.ABOUT
-
+include *.toml
+include *.yml
+include *.rst
 include setup.*
 include configure*
 include requirements*
-include *.toml
+include .git*
 
 include extractcode*
 include scancode*
 
 # path to executable used by a built app
 include PYTHON_EXECUTABLE
 
-include *.rst
 include Dockerfile
 include .VERSION
 

README.rst

@@ -198,10 +198,10 @@ For discussions and chats, we have:
   Gitter is also accessible via an `IRC bridge <https://irc.gitter.im/>`_.
   There are other AboutCode project-specific channels available there too.
 
-* an official `#aboutcode` IRC channel on freenode (server chat.freenode.net).
+* an official `#aboutcode` IRC channel on liberachat (server web.libera.chat).
   This channel receives build and commit notifications and can be noisy.
   You can use your favorite IRC client or use the `web chat 
-  <https://webchat.freenode.net/>`_.
+  <https://web.libera.chat/?#aboutcode>`_.
 
 
 Source code and downloads