Support pyaml5

.gitattributes

@@ -0,0 +1,2 @@
+# Ignore all Git auto CR/LF line endings conversions
+* -text

.gitignore

@@ -1,6 +1,3 @@
-# ScanCode special files
-/SCANCODE_DEV_MODE
-
 # Python compiled files
 *.py[cod]
 
@@ -44,9 +41,16 @@ htmlcov
 .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
@@ -59,3 +63,10 @@ docs/_build
 
 # 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

@@ -1,22 +1,21 @@
-language: python
+# This is a skeleton Travis CI config file that provides a starting point for adding CI
+# to a Python project. Since we primarily develop in python3, this skeleton config file
+# will be specific to that language.
+#
+# See https://config.travis-ci.com/ for a full list of configuration options.
+
+os: linux
+
+dist: xenial
 
+language: python
 python:
-  - "2.7"
   - "3.6"
+  - "3.7"
+  - "3.8"
 
-install:
-    - pip install -r requirements_dev.txt
-
-script:
-    - bin/py.test -vvs tests
+# Scripts to run at install stage
+install: ./configure
 
-notifications:
-    irc:
-        channels:
-          - "chat.freenode.net#aboutcode"
-    on_success: change
-    on_failure: always
-    use_notice: true
-    skip_join: true
-    template:
-      - "%{repository_slug}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} : %{build_url}"
+# Scripts to run at script stage
+script: tmp/bin/pytest

AUTHORS.rst

@@ -0,0 +1,3 @@
+The following organizations or individuals have contributed to this repo:
+
+- 

CHANGELOG.rst

@@ -1,7 +1,30 @@
 Changelog
 =========
 
-0.1 (2018-11-17)
-----------------
+v0.5 (2021-03-31)
+-----------------
 
-Initial release.
+- Adopt https://github.com/nexB/skeleton
+- Support Python 3 only, drop Python 2 support
+- Support both PyYAML 5.x only
+- Drop travis for Azure pipelines
+
+
+v0.4 (2019-04-10)
+-----------------
+
+- Dump nulls correctly
+- Fix CI on Travis
+- Attempt to support PyYAML 5.x partially
+
+
+v0.3 (2019-04-07)
+-----------------
+
+- Use OrderedDict to keep ordering of mappings
+
+
+v0.1 (2018-11-17)
+-----------------
+
+- Initial release based on code originally used in ScanCode toolkit.

MANIFEST.in

@@ -1,19 +1,15 @@
 graft src
-graft tests
 
-prune src/saneyaml.egg-info
-
-include CHANGELOG.rst
-include README.rst
-include CONTRIBUTING.rst
-include apache-2.0.LICENSE
+include *.LICENSE
 include NOTICE
-include MANIFEST.in
-include setup.py
-include setup.cfg
-include .gitignore
-include .travis.yml
-include appveyor.yml
-include saneyaml.ABOUT
+include *.ABOUT
+include *.toml
+include *.yml
+include *.rst
+include setup.*
+include configure*
+include requirements*
+include .git*
 
 global-exclude *.py[co] __pycache__ *.*~
+

NOTICE

@@ -1,12 +1,19 @@
-Copyright (c) 2018 nexB Inc. and others. All rights reserved.
-http://nexb.com and https://github.com/nexB/saneyaml/
-
-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.
+#
+# 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.
+#

README.rst

@@ -10,7 +10,7 @@ preserving ordering and avoiding surprises of type conversions by loading
 everything except booleans as strings.
 Optionally you can check for duplicated map keys when loading YAML.
 
-Works with Python 2 and 3. Requires PyYAML.
+Works with Python 3. Requires PyYAML 5.x.
 
 License: apache-2.0
 Homepage_url: https://github.com/nexB/saneyaml
@@ -42,4 +42,3 @@ version: 3.0.0.dev6
 description: |
   AboutCode Toolkit is a tool to process ABOUT files. An ABOUT file
   provides a way to document a software component.
-

apache-2.0.LICENSE

@@ -174,3 +174,28 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

appveyor.yml

@@ -1,16 +1,12 @@
 version: '{build}'
 
-install:
-    - configure etc/conf/dev
-
 build: off
 
 test_script:
-    - set
+    - pip install pyyaml
+    - pip install -r requirements_dev.txt
+# test also on latest version
+    - py.test -vvs tests
+    - pip uninstall -y pyyaml
+    - pip install pyyaml
     - py.test -vvs tests
-
-on_success:
-  - "python etc/scripts/irc-notify.py aboutcode [{project_name}:{branch}] {short_commit}: \"{message}\" ({author}) {color_green}Succeeded,Details: {build_url},Commit: {commit_url}"
-
-on_failure:
-  - "python etc/scripts/irc-notify.py aboutcode [{project_name}:{branch}] {short_commit}: \"{message}\" ({author}) {color_red}Failed,Details: {build_url},Commit: {commit_url}"

azure-pipelines.yml

@@ -0,0 +1,64 @@
+
+################################################################################
+# We use Azure to run the full tests suites on multiple Python 3.x
+# on multiple Windows, macOS and Linux versions all on 64 bits
+# These jobs are using VMs with Azure-provided Python builds
+################################################################################
+
+jobs:
+
+    - template: etc/ci/azure-linux.yml
+      parameters:
+          job_name: ubuntu16_cpython
+          image_name: ubuntu-16.04
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp/bin/pytest -vvs
+
+    - template: etc/ci/azure-linux.yml
+      parameters:
+          job_name: ubuntu18_cpython
+          image_name: ubuntu-18.04
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-linux.yml
+      parameters:
+          job_name: ubuntu20_cpython
+          image_name: ubuntu-20.04
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-mac.yml
+      parameters:
+          job_name: macos1014_cpython
+          image_name: macos-10.14
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-mac.yml
+      parameters:
+          job_name: macos1015_cpython
+          image_name: macos-10.15
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-win.yml
+      parameters:
+          job_name: win2016_cpython
+          image_name: vs2017-win2016
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp\Scripts\pytest -n 2 -vvs
+
+    - template: etc/ci/azure-win.yml
+      parameters:
+          job_name: win2019_cpython
+          image_name: windows-2019
+          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          test_suites:
+              all: tmp\Scripts\pytest -n 2 -vvs

configure

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) nexB Inc. and others.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+set -e
+#set -x
+
+# source this script for a basic setup and configuration for local development
+
+CONFIGURE_ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+
+if [[ "$1" == "--clean" ]]; then
+    rm -rf "$CONFIGURE_ROOT_DIR/tmp"
+    exit
+fi
+
+
+if [[ "$PYTHON_EXE" == "" ]]; then
+    PYTHON_EXE=python3
+fi
+
+
+function setup {
+    # create a virtualenv on Python
+    mkdir -p $CONFIGURE_ROOT_DIR/tmp
+    wget -O $CONFIGURE_ROOT_DIR/tmp/virtualenv.pyz https://bootstrap.pypa.io/virtualenv.pyz
+    $PYTHON_EXE $CONFIGURE_ROOT_DIR/tmp/virtualenv.pyz $CONFIGURE_ROOT_DIR/tmp
+    source $CONFIGURE_ROOT_DIR/tmp/bin/activate
+    $CONFIGURE_ROOT_DIR/tmp/bin/pip install --upgrade pip virtualenv setuptools wheel
+}
+
+
+setup
+
+$CONFIGURE_ROOT_DIR/tmp/bin/pip install -e .[testing]
+
+if [ -f "$CONFIGURE_ROOT_DIR/tmp/bin/activate" ]; then
+    source "$CONFIGURE_ROOT_DIR/tmp/bin/activate"
+fi
+
+set +e