Merge pull request #40 from nexB/prepare-release

Prepare release

.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.9]
+
+    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
+
+

.github/workflows/pypi-release.yml

@@ -0,0 +1,27 @@
+name: Release library as a PyPI wheel and sdist on GH release creation
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-and-publish-to-pypi:
+    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 }}
+

CHANGELOG.rst

@@ -1,7 +1,13 @@
 Changelog
 =========
 
-v30.0.0 (next)
+v31.0.0
+--------
+
+- Do not install patch.py by default. Instead this is now an extra
+
+
+v30.0.0
 --------
 
 - Update to the latest skeleton. The virtualenv is now created under the venv

CODE_OF_CONDUCT.rst

@@ -0,0 +1,86 @@
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age, body size, disability, ethnicity, gender identity and
+expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+-  Using welcoming and inclusive language
+-  Being respectful of differing viewpoints and experiences
+-  Gracefully accepting constructive criticism
+-  Focusing on what is best for the community
+-  Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+-  The use of sexualized language or imagery and unwelcome sexual
+   attention or advances
+-  Trolling, insulting/derogatory comments, and personal or political
+   attacks
+-  Public or private harassment
+-  Publishing others’ private information, such as a physical or
+   electronic address, without explicit permission
+-  Other conduct which could reasonably be considered inappropriate in a
+   professional setting
+
+Our Responsibilities
+--------------------
+
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair
+corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they
+deem inappropriate, threatening, offensive, or harmful.
+
+Scope
+-----
+
+This Code of Conduct applies both within project spaces and in public
+spaces when an individual is representing the project or its community.
+Examples of representing a project or community include using an
+official project e-mail address, posting via an official social media
+account, or acting as an appointed representative at an online or
+offline event. Representation of a project may be further defined and
+clarified by project maintainers.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported by contacting the project team at [email protected]
+or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss .
+All complaints will be reviewed and investigated and will result in a
+response that is deemed necessary and appropriate to the circumstances.
+The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement
+policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in
+good faith may face temporary or permanent repercussions as determined
+by other members of the project’s leadership.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the `Contributor Covenant`_ ,
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+.. _Contributor Covenant: https://www.contributor-covenant.org

MANIFEST.in

@@ -9,7 +9,9 @@ include *.rst
 include setup.*
 include configure*
 include requirements*
-include .git*
+include .giti*
+
+include extractcode*
 
 global-exclude *.py[co] __pycache__ *.*~
 

README.rst

@@ -1,5 +1,6 @@
+============
 ExtractCode
-===========
+============
 
 - license: Apache-2.0
 - copyright: copyright (c) nexB. Inc. and others
@@ -21,7 +22,7 @@ Why another extractor?
 
 **it will extract!**
 
-ExtractCode will extract things where other extractors may fail.
+ExtractCode will extract things where other archive and compressed file extractors may fail.
 
 ExtractCode supports one of largest number of archive formats listed in the
 long  `List of supported archive formats`_ found at the bottom of this document.

appveyor.yml

@@ -0,0 +1,19 @@
+
+################################################################################
+# We use  Appveyor to run minimal smoke tests suites on Pythons 3.x
+# on Windows 64 bits
+################################################################################
+environment:
+    matrix:
+        - PYTHON: "C:\\Python36-x64"
+#        - PYTHON: "C:\\Python37-x64"
+#        - PYTHON: "C:\\Python38-x64"
+#        - PYTHON: "C:\\Python39-x64"
+
+
+build: off
+
+
+test_script:
+    - python -c "import sys;print(sys.getdefaultencoding())"
+    - cmd: "set PYTHON_EXECUTABLE=%PYTHON%\\python.exe && configure --dev && venv\\Scripts\\pytest -vvs tests"

azure-pipelines.yml

@@ -7,58 +7,50 @@
 
 jobs:
 
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu16_cpython
-          image_name: ubuntu-16.04
-          python_versions: ['3.6', '3.7', '3.8', '3.9']
-          test_suites:
-              all: sudo chmod 0644 /boot/vmlinuz-* && sudo apt install libguestfs-tools && tmp/bin/pytest -vvs
-
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu18_cpython
           image_name: ubuntu-18.04
-          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          python_versions: ['3.6', '3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: sudo chmod 0644 /boot/vmlinuz-* && sudo apt install libguestfs-tools && venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu20_cpython
           image_name: ubuntu-20.04
-          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          python_versions: ['3.6', '3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: sudo chmod 0644 /boot/vmlinuz-* && sudo apt install libguestfs-tools && venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
-          job_name: macos1014_cpython
-          image_name: macos-10.14
-          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          job_name: macos1015_cpython
+          image_name: macos-10.15
+          python_versions: ['3.6', '3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
-          job_name: macos1015_cpython
-          image_name: macos-10.15
-          python_versions: ['3.6', '3.7', '3.8', '3.9']
+          job_name: macos11_cpython
+          image_name: macos-11
+          python_versions: ['3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: venv/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']
+          job_name: win2019_cpython
+          image_name: windows-2019
+          python_versions: ['3.6', '3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: venv\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']
+          job_name: win2022_cpython
+          image_name: windows-2022
+          python_versions: ['3.7', '3.8', '3.9', '3.10']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs