plugincode - pypi Package Compare versions

Comparing version 30.0.0 to 31.0.0b1

.github/workflows/pypi-release.yml

@@ -1,27 +0,83 @@
-name: Release library as a PyPI wheel and sdist on GH release creation
+name: Create library release archives, create a GH release and publish PyPI wheel and sdist on tag in main branch
 
+
+# This is executed automatically on a tag in the main branch
+
+# Summary of the steps:
+# - build wheels and sdist
+# - upload wheels and sdist to PyPI
+# - create gh-release and upload wheels and dists there
+# TODO: smoke test wheels and sdist
+# TODO: add changelog to release text body
+
+# WARNING: this is designed only for packages building as pure Python wheels
+
 on:
-  release:
-    types: [created]
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*.*.*"
 
 jobs:
-  build-and-publish-to-pypi:
+  build-pypi-distribs:
     name: Build and publish library to PyPI
     runs-on: ubuntu-20.04
+
     steps:
-     - uses: actions/checkout@master
-     - name: Set up Python
-       uses: actions/setup-python@v1
-       with:
-         python-version: 3.9
-     - name: Install pypa/build
-       run: python -m pip install build --user
-     - name: Build a binary wheel and a source tarball
-       run: python -m build --sdist --wheel --outdir dist/
-        .
-     - name: Publish distribution  to PyPI
-       if: startsWith(github.ref, 'refs/tags')
-       uses: pypa/gh-action-pypi-publish@master
-       with:
-         password: ${{ secrets.PYPI_API_TOKEN }}
-        
+      - uses: actions/checkout@master
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+
+      - name: Install pypa/build
+        run: python -m pip install build --user
+
+      - name: Build a binary wheel and a source tarball
+        run: python -m build --sdist --wheel --outdir dist/
+
+      - name: Upload built archives
+        uses: actions/upload-artifact@v3
+        with:
+          name: pypi_archives
+          path: dist/*
+
+
+  create-gh-release:
+    name: Create GH release
+    needs:
+      - build-pypi-distribs
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Download built archives
+        uses: actions/download-artifact@v3
+        with:
+          name: pypi_archives
+          path: dist
+
+      - name: Create GH release
+        uses: softprops/action-gh-release@v1
+        with:
+          draft: true
+          files: dist/*
+
+
+  create-pypi-release:
+    name: Create PyPI release
+    needs:
+      - create-gh-release
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Download built archives
+        uses: actions/download-artifact@v3
+        with:
+          name: pypi_archives
+          path: dist
+
+      - name: Publish to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.rst

@@ -5,2 +5,10 @@ Release notes
 
+v31.0.0
+--------
+
+- Adop new commoncode Codebase and Resource
+- Use latest skeleton
+- Bump dependencies
+
+
 v30.0.0
@@ -7,0 +15,0 @@ --------

configure.bat

@@ -55,7 +55,6 @@ @echo OFF
 @rem # Thirdparty package locations and index handling
-@rem # Find packages from the local thirdparty directory or from thirdparty.aboutcode.org
+@rem # Find packages from the local thirdparty directory
 if exist "%CFG_ROOT_DIR%\thirdparty" (
     set PIP_EXTRA_ARGS=--find-links "%CFG_ROOT_DIR%\thirdparty"
 )
-set "PIP_EXTRA_ARGS=%PIP_EXTRA_ARGS% --find-links https://thirdparty.aboutcode.org/pypi/simple/links.html"
 
@@ -73,3 +72,2 @@
 set "CFG_REQUIREMENTS=%REQUIREMENTS%"
-set "NO_INDEX=--no-index"
 
@@ -76,0 +74,0 @@ :again

docs/source/conf.py

@@ -31,3 +31,3 @@ # Configuration file for the Sphinx documentation builder.
 extensions = [
-'sphinx.ext.intersphinx',
+    "sphinx.ext.intersphinx",
 ]
@@ -40,4 +40,4 @@
 intersphinx_mapping = {
-    'aboutcode': ('https://aboutcode.readthedocs.io/en/latest/', None),
-    'scancode-workbench': ('https://scancode-workbench.readthedocs.io/en/develop/', None),
+    "aboutcode": ("https://aboutcode.readthedocs.io/en/latest/", None),
+    "scancode-workbench": ("https://scancode-workbench.readthedocs.io/en/develop/", None),
 }
@@ -67,3 +67,3 @@
 
-master_doc = 'index'
+master_doc = "index"
 
@@ -78,5 +78,3 @@ html_context = {
 
-html_css_files = [
-    '_static/theme_overrides.css'
-    ]
+html_css_files = ["_static/theme_overrides.css"]
 
@@ -83,0 +81,0 @@

etc/scripts/fetch_thirdparty.py

@@ -113,3 +113,2 @@ #!/usr/bin/env python
 )
-
 @click.help_option("-h", "--help")
@@ -116,0 +115,0 @@ def fetch_thirdparty(

MANIFEST.in

@@ -12,5 +12,5 @@ graft src
 include requirements*
-include .git*
+include .giti*
 
 global-exclude *.py[co] __pycache__ *.*~
 

PKG-INFO

 Metadata-Version: 2.1
 Name: plugincode
-Version: 30.0.0
+Version: 31.0.0b1
 Summary: plugincode is a library that provides plugin functionality for ScanCode toolkit.
@@ -9,4 +9,3 @@ Home-page: https://github.com/nexB/plugincode
 License: Apache-2.0
-Keywords: open source,utilities,plugincode,scancode,scancode-toolkit,plugins
-Platform: UNKNOWN
+Keywords: open source,utilities,plugincode,scancode,scancode-toolkit,plugins,open source,plugin
 Classifier: Development Status :: 5 - Production/Stable
@@ -31,2 +30,3 @@ Classifier: Intended Audience :: Developers
 License-File: CHANGELOG.rst
+License-File: CODE_OF_CONDUCT.rst
 
@@ -61,3 +61,1 @@ ===========
 
-
-

requirements-dev.txt

@@ -1,2 +0,2 @@
-aboutcode-toolkit==7.0.1
+aboutcode-toolkit==7.0.2
 bleach==4.1.0
@@ -3,0 +3,0 @@ build==0.7.0

requirements.txt

@@ -5,3 +5,3 @@ attrs==21.4.0
 binaryornot==0.4.4
-boolean.py==3.8
+boolean.py==4.0
 certifi==2021.10.8
@@ -13,5 +13,5 @@ cffi==1.15.0
 colorama==0.4.4
-commoncode==30.2.0
+commoncode==31.0.0b4
 construct==2.10.68
-container-inspector==30.0.0
+container-inspector==31.0.0
 cryptography==36.0.2
@@ -21,3 +21,3 @@ debian-inspector==30.0.0
 dparse2==0.6.1
-extractcode==30.0.0
+extractcode==31.0.0
 extractcode-7z==16.5.210531
@@ -40,3 +40,3 @@ extractcode-libarchive==3.5.1.210531
 jsonstreams==0.6.0
-license-expression==21.6.14
+license-expression==30.0.0
 lxml==4.8.0
@@ -51,3 +51,3 @@ MarkupSafe==2.0.1
 patch==1.16
-pdfminer.six==20220506
+pdfminer-six==20220506
 pefile==2021.9.3
@@ -68,3 +68,3 @@ pip-requirements-parser==31.2.0
 rdflib==5.0.0
-regipy==2.2.2
+regipy==2.3.1
 requests==2.27.1
@@ -78,3 +78,3 @@ rpm-inspector-rpm==4.16.1.3.210404
 toml==0.10.2
-typecode==21.6.1
+typecode==30.0.0
 typecode-libmagic==5.39.210531
@@ -81,0 +81,0 @@ urllib3==1.26.9

setup.cfg

@@ -29,2 +29,4 @@ [metadata]
 	plugins
+	open source
+	plugin
 license_files = 
@@ -35,2 +37,3 @@ apache-2.0.LICENSE
 	CHANGELOG.rst
+	CODE_OF_CONDUCT.rst
 
@@ -37,0 +40,0 @@ [options]

src/plugincode.egg-info/PKG-INFO

 Metadata-Version: 2.1
 Name: plugincode
-Version: 30.0.0
+Version: 31.0.0b1
 Summary: plugincode is a library that provides plugin functionality for ScanCode toolkit.
@@ -9,4 +9,3 @@ Home-page: https://github.com/nexB/plugincode
 License: Apache-2.0
-Keywords: open source,utilities,plugincode,scancode,scancode-toolkit,plugins
-Platform: UNKNOWN
+Keywords: open source,utilities,plugincode,scancode,scancode-toolkit,plugins,open source,plugin
 Classifier: Development Status :: 5 - Production/Stable
@@ -31,2 +30,3 @@ Classifier: Intended Audience :: Developers
 License-File: CHANGELOG.rst
+License-File: CODE_OF_CONDUCT.rst
 
@@ -61,3 +61,1 @@ ===========
 
-
-

src/plugincode/__init__.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 #
-# 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.
-#
+
 from collections import defaultdict
@@ -21,0 +10,0 @@ import sys

src/plugincode/location_provider.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@ import logging

src/plugincode/output_filter.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@ from plugincode import CodebasePlugin

src/plugincode/output.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+
 import functools
@@ -80,7 +68,20 @@
         # (e.g. JSON) and only these should serialize
-        timing = kwargs.get("timing", False)
-        info = bool(kwargs.get("info") or getattr(codebase, "with_info", False))
-        serializer = functools.partial(Resource.to_dict, with_info=info, with_timing=timing)
+        with_timing = kwargs.get("timing", False)
+        with_info = bool(kwargs.get("info") or getattr(codebase, "with_info", False))
 
-        strip_root = kwargs.get("strip_root", False)
+        full_root = kwargs.get("full_root", False)
+
+        if codebase.has_single_resource:
+            strip_root = False
+        else:
+            strip_root = kwargs.get("strip_root", False)
+
+        serializer = functools.partial(
+            Resource.to_dict,
+            with_info=with_info,
+            with_timing=with_timing,
+            full_root=full_root,
+            strip_root=strip_root,
+        )
+
         resources = codebase.walk_filtered(topdown=True, skip_root=strip_root)
@@ -87,0 +88,0 @@ return map(serializer, resources)

src/plugincode/post_scan.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@ from plugincode import CodebasePlugin

src/plugincode/pre_scan.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@ from plugincode import CodebasePlugin

src/plugincode/scan.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@ from plugincode import CodebasePlugin

tests/plugincode/test_plugincode.py

 #
-# Copyright (c) nexB Inc. and others.
+# Copyright (c) nexB Inc. and others. All rights reserved.
 # 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.
-#
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/plugincode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
 
@@ -21,0 +8,0 @@

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Worsened metrics

Total package byte prevSize

256392

-0.76%

Lines of code

4266

-2%