Skip to content

Commit a2a1901

Browse files
steven-essersteven-esser
authored
Merge pull request #19 from nexB/update-boilerplate
Update boilerplate
2 parents 98d4d69 + d3e2d28 commit a2a1901

File tree

11 files changed

+212
-155
lines changed

11 files changed

+212
-155
lines changed

‎.gitattributes

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
# Set configure.bat's line ending to CRLF. Sometimes batch scripts don't work
2-
# properly on Windows if the line ending is LF and not CRLF
3-
configure.bat eol=crlf
1+
# Ignore all Git auto CR/LF line endings conversions
2+
* binary

‎MANIFEST.in

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
graft src
2+
3+
include *.LICENSE
4+
include NOTICE
5+
include *.ABOUT
6+
include *.toml
7+
include *.yml
8+
include *.rst
9+
include setup.*
10+
include configure*
11+
include requirements*
12+
include .git*
13+
14+
global-exclude *.py[co] __pycache__ *.*~
15+

‎NOTICE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#
2+
# Copyright (c) nexB Inc. and others.
3+
# SPDX-License-Identifier: Apache-2.0
4+
#
5+
# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
6+
# ScanCode is a trademark of nexB Inc.
7+
#
8+
# Licensed under the Apache License, Version 2.0 (the "License");
9+
# you may not use this file except in compliance with the License.
10+
# You may obtain a copy of the License at
11+
#
12+
# http://www.apache.org/licenses/LICENSE-2.0
13+
#
14+
# Unless required by applicable law or agreed to in writing, software
15+
# distributed under the License is distributed on an "AS IS" BASIS,
16+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
# See the License for the specific language governing permissions and
18+
# limitations under the License.
19+
#

‎azure-pipelines.yml

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,64 @@
11

22
################################################################################
3-
# We use Azure to run the full tests suites on Python 3.6
4-
# on Windows (32 and 64), macOS and Linux (64 various distro)
3+
# We use Azure to run the full tests suites on multiple Python 3.x
4+
# on multiple Windows, macOS and Linux versions all on 64 bits
5+
# These jobs are using VMs with Azure-provided Python builds
56
################################################################################
67

78
jobs:
89

9-
################################################################################
10-
# These jobs are using VMs and Azure-provided Python 3.6
11-
################################################################################
10+
- template: etc/ci/azure-linux.yml
11+
parameters:
12+
job_name: ubuntu16_cpython
13+
image_name: ubuntu-16.04
14+
python_versions: ['3.6', '3.7', '3.8', '3.9']
15+
test_suites:
16+
all: tmp/bin/pytest -vvs
1217

1318
- template: etc/ci/azure-linux.yml
1419
parameters:
15-
job_name: ubuntu18_py36
20+
job_name: ubuntu18_cpython
1621
image_name: ubuntu-18.04
17-
python_versions: ['3.6']
22+
python_versions: ['3.6', '3.7', '3.8', '3.9']
23+
test_suites:
24+
all: tmp/bin/pytest -n 2 -vvs
25+
26+
- template: etc/ci/azure-linux.yml
27+
parameters:
28+
job_name: ubuntu20_cpython
29+
image_name: ubuntu-20.04
30+
python_versions: ['3.6', '3.7', '3.8', '3.9']
31+
test_suites:
32+
all: tmp/bin/pytest -n 2 -vvs
33+
34+
- template: etc/ci/azure-mac.yml
35+
parameters:
36+
job_name: macos1014_cpython
37+
image_name: macos-10.14
38+
python_versions: ['3.6', '3.7', '3.8', '3.9']
1839
test_suites:
1940
all: tmp/bin/pytest -n 2 -vvs
2041

2142
- template: etc/ci/azure-mac.yml
2243
parameters:
23-
job_name: macos1015_py36
44+
job_name: macos1015_cpython
2445
image_name: macos-10.15
25-
python_versions: ['3.6']
46+
python_versions: ['3.6', '3.7', '3.8', '3.9']
2647
test_suites:
2748
all: tmp/bin/pytest -n 2 -vvs
2849

2950
- template: etc/ci/azure-win.yml
3051
parameters:
31-
job_name: win2019_32_py36
32-
image_name: windows-2019
33-
python_versions: ['3.6']
34-
python_architecture: x86
52+
job_name: win2016_cpython
53+
image_name: vs2017-win2016
54+
python_versions: ['3.6', '3.7', '3.8', '3.9']
3555
test_suites:
36-
all: tmp\Scripts\pytest -vvs
56+
all: tmp\Scripts\pytest -n 2 -vvs
3757

3858
- template: etc/ci/azure-win.yml
3959
parameters:
40-
job_name: win2019_64_py36
60+
job_name: win2019_cpython
4161
image_name: windows-2019
42-
python_versions: ['3.6']
43-
python_architecture: x64
62+
python_versions: ['3.6', '3.7', '3.8', '3.9']
4463
test_suites:
45-
all: tmp\Scripts\pytest -vvs
64+
all: tmp\Scripts\pytest -n 2 -vvs

‎configure

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#!/usr/bin/env bash
22
#
3-
# Copyright (c) nexB Inc. http://www.nexb.com/ - All rights reserved.
3+
# Copyright (c) nexB Inc. and others.
4+
# SPDX-License-Identifier: Apache-2.0
45
#
56

67
set -e

‎configure.bat

Lines changed: 121 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,121 @@
1-
@echo OFF
2-
@setlocal
3-
@rem Copyright (c) nexB Inc. http://www.nexb.com/ - All rights reserved.
4-
5-
@rem ################################
6-
@rem # A configuration script for Windows
7-
@rem #
8-
@rem # The options and (optional) arguments are:
9-
@rem # --clean : this is exclusive of anything else and cleans the environment
10-
@rem # from built and installed files
11-
@rem #
12-
@rem # --python < path to python.exe> : this must be the first argument and set
13-
@rem # the path to the Python executable to use. If < path to python.exe> is
14-
@rem # set to "path", then the executable will be the python.exe available
15-
@rem # in the PATH.
16-
@rem ################################
17-
18-
@rem Current directory where this .bat files lives
19-
set CFG_ROOT_DIR=%~dp0
20-
@rem path where a configured Python should live in the current virtualenv if installed
21-
set CONFIGURED_PYTHON=%CFG_ROOT_DIR%tmp\Scripts\python.exe
22-
set PYTHON_EXECUTABLE=
23-
24-
25-
@rem parse command line options and arguments
26-
:collectopts
27-
if "%1" EQU "--help" (goto cli_help)
28-
if "%1" EQU "--clean" (call rmdir /s /q "%CFG_ROOT_DIR%tmp") && call exit /b
29-
if "%1" EQU "--python" (set PROVIDED_PYTHON=%~2) && shift && shift && goto collectopts
30-
31-
@rem If we have a pre-configured Python in our virtualenv, reuse this as-is and run
32-
if exist ""%CONFIGURED_PYTHON%"" (
33-
set PYTHON_EXECUTABLE=%CONFIGURED_PYTHON%
34-
goto run
35-
)
36-
37-
@rem If we have a command arg for Python use this as-is
38-
if ""%PROVIDED_PYTHON%""==""path"" (
39-
@rem use a bare python available in the PATH
40-
set PYTHON_EXECUTABLE=python
41-
goto run
42-
)
43-
if exist ""%PROVIDED_PYTHON%"" (
44-
set PYTHON_EXECUTABLE=%PROVIDED_PYTHON%
45-
goto run
46-
)
47-
48-
49-
@rem otherwise we search for a suitable Python interpreter
50-
:find_python
51-
@rem First check the existence of the "py" launcher (available in Python 3)
52-
@rem if we have it, check if we have a py -3 installed with the good version or a py 2.7
53-
@rem if not, check if we have an old py 2.7
54-
@rem exist if all fails
55-
56-
where py >nul 2>nul
57-
if %ERRORLEVEL% == 0 (
58-
@rem we have a py launcher, check for the availability of our required Python 3 version
59-
py -3.6 --version >nul 2>nul
60-
if %ERRORLEVEL% == 0 (
61-
set PYTHON_EXECUTABLE=py -3.6
62-
) else (
63-
@rem we have no required python 3, let's try python 2:
64-
py -2 --version >nul 2>nul
65-
if %ERRORLEVEL% == 0 (
66-
set PYTHON_EXECUTABLE=py -2
67-
) else (
68-
@rem we have py and no python 3 and 2, exit
69-
echo * Unable to find an installation of Python.
70-
exit /b 1
71-
)
72-
)
73-
) else (
74-
@rem we have no py launcher, check for a default Python 2 installation
75-
if not exist ""%DEFAULT_PYTHON2%"" (
76-
echo * Unable to find an installation of Python.
77-
exit /b 1
78-
) else (
79-
set PYTHON_EXECUTABLE=%DEFAULT_PYTHON2%
80-
)
81-
)
82-
83-
84-
:run
85-
@rem without this things may not always work on Windows 10, but this makes things slower
86-
set PYTHONDONTWRITEBYTECODE=1
87-
88-
call mkdir "%CFG_ROOT_DIR%tmp"
89-
call curl -o "%CFG_ROOT_DIR%tmp\virtualenv.pyz" https://bootstrap.pypa.io/virtualenv.pyz
90-
call %PYTHON_EXECUTABLE% "%CFG_ROOT_DIR%tmp\virtualenv.pyz" "%CFG_ROOT_DIR%tmp"
91-
call "%CFG_ROOT_DIR%tmp\Scripts\activate"
92-
call "%CFG_ROOT_DIR%tmp\Scripts\pip" install --upgrade pip virtualenv setuptools wheel
93-
call "%CFG_ROOT_DIR%tmp\Scripts\pip" install -e .[testing]
94-
95-
@rem Return a proper return code on failure
96-
if %ERRORLEVEL% neq 0 (
97-
exit /b %ERRORLEVEL%
98-
)
99-
endlocal
100-
goto activate
101-
102-
103-
:cli_help
104-
echo A configuration script for Windows
105-
echo usage: configure [options] [path/to/config/directory]
106-
echo.
107-
echo The options and arguments are:
108-
echo --clean : this is exclusive of anything else and cleans the environment
109-
echo from built and installed files
110-
echo.
111-
echo --python path/to/python.exe : this is set to the path of an alternative
112-
echo Python executable to use. If path/to/python.exe is set to "path",
113-
echo then the executable will be the python.exe available in the PATH.
114-
echo.
115-
116-
117-
:activate
118-
@rem Activate the virtualenv
119-
if exist "%CFG_ROOT_DIR%tmp\Scripts\activate" (
120-
"%CFG_ROOT_DIR%tmp\Scripts\activate"
121-
)
1+
@echo OFF
2+
@setlocal
3+
@rem Copyright (c) nexB Inc. http://www.nexb.com/ - All rights reserved.
4+
5+
@rem ################################
6+
@rem # A configuration script for Windows
7+
@rem #
8+
@rem # The options and (optional) arguments are:
9+
@rem # --clean : this is exclusive of anything else and cleans the environment
10+
@rem # from built and installed files
11+
@rem #
12+
@rem # --python < path to python.exe> : this must be the first argument and set
13+
@rem # the path to the Python executable to use. If < path to python.exe> is
14+
@rem # set to "path", then the executable will be the python.exe available
15+
@rem # in the PATH.
16+
@rem ################################
17+
18+
@rem Current directory where this .bat files lives
19+
set CFG_ROOT_DIR=%~dp0
20+
@rem path where a configured Python should live in the current virtualenv if installed
21+
set CONFIGURED_PYTHON=%CFG_ROOT_DIR%tmp\Scripts\python.exe
22+
set PYTHON_EXECUTABLE=
23+
24+
25+
@rem parse command line options and arguments
26+
:collectopts
27+
if "%1" EQU "--help" (goto cli_help)
28+
if "%1" EQU "--clean" (call rmdir /s /q "%CFG_ROOT_DIR%tmp") && call exit /b
29+
if "%1" EQU "--python" (set PROVIDED_PYTHON=%~2) && shift && shift && goto collectopts
30+
31+
@rem If we have a pre-configured Python in our virtualenv, reuse this as-is and run
32+
if exist ""%CONFIGURED_PYTHON%"" (
33+
set PYTHON_EXECUTABLE=%CONFIGURED_PYTHON%
34+
goto run
35+
)
36+
37+
@rem If we have a command arg for Python use this as-is
38+
if ""%PROVIDED_PYTHON%""==""path"" (
39+
@rem use a bare python available in the PATH
40+
set PYTHON_EXECUTABLE=python
41+
goto run
42+
)
43+
if exist ""%PROVIDED_PYTHON%"" (
44+
set PYTHON_EXECUTABLE=%PROVIDED_PYTHON%
45+
goto run
46+
)
47+
48+
49+
@rem otherwise we search for a suitable Python interpreter
50+
:find_python
51+
@rem First check the existence of the "py" launcher (available in Python 3)
52+
@rem if we have it, check if we have a py -3 installed with the good version or a py 2.7
53+
@rem if not, check if we have an old py 2.7
54+
@rem exist if all fails
55+
56+
where py >nul 2>nul
57+
if %ERRORLEVEL% == 0 (
58+
@rem we have a py launcher, check for the availability of our required Python 3 version
59+
py -3.6 --version >nul 2>nul
60+
if %ERRORLEVEL% == 0 (
61+
set PYTHON_EXECUTABLE=py -3.6
62+
) else (
63+
@rem we have no required python 3, let's try python 2:
64+
py -2 --version >nul 2>nul
65+
if %ERRORLEVEL% == 0 (
66+
set PYTHON_EXECUTABLE=py -2
67+
) else (
68+
@rem we have py and no python 3 and 2, exit
69+
echo * Unable to find an installation of Python.
70+
exit /b 1
71+
)
72+
)
73+
) else (
74+
@rem we have no py launcher, check for a default Python 2 installation
75+
if not exist ""%DEFAULT_PYTHON2%"" (
76+
echo * Unable to find an installation of Python.
77+
exit /b 1
78+
) else (
79+
set PYTHON_EXECUTABLE=%DEFAULT_PYTHON2%
80+
)
81+
)
82+
83+
84+
:run
85+
@rem without this things may not always work on Windows 10, but this makes things slower
86+
set PYTHONDONTWRITEBYTECODE=1
87+
88+
call mkdir "%CFG_ROOT_DIR%tmp"
89+
call curl -o "%CFG_ROOT_DIR%tmp\virtualenv.pyz" https://bootstrap.pypa.io/virtualenv.pyz
90+
call %PYTHON_EXECUTABLE% "%CFG_ROOT_DIR%tmp\virtualenv.pyz" "%CFG_ROOT_DIR%tmp"
91+
call "%CFG_ROOT_DIR%tmp\Scripts\activate"
92+
call "%CFG_ROOT_DIR%tmp\Scripts\pip" install --upgrade pip virtualenv setuptools wheel
93+
call "%CFG_ROOT_DIR%tmp\Scripts\pip" install -e .[testing]
94+
95+
@rem Return a proper return code on failure
96+
if %ERRORLEVEL% neq 0 (
97+
exit /b %ERRORLEVEL%
98+
)
99+
endlocal
100+
goto activate
101+
102+
103+
:cli_help
104+
echo A configuration script for Windows
105+
echo usage: configure [options] [path/to/config/directory]
106+
echo.
107+
echo The options and arguments are:
108+
echo --clean : this is exclusive of anything else and cleans the environment
109+
echo from built and installed files
110+
echo.
111+
echo --python path/to/python.exe : this is set to the path of an alternative
112+
echo Python executable to use. If path/to/python.exe is set to "path",
113+
echo then the executable will be the python.exe available in the PATH.
114+
echo.
115+
116+
117+
:activate
118+
@rem Activate the virtualenv
119+
if exist "%CFG_ROOT_DIR%tmp\Scripts\activate" (
120+
"%CFG_ROOT_DIR%tmp\Scripts\activate"
121+
)

‎pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ norecursedirs = [
3636

3737
python_files = "*.py"
3838

39-
python_classes="Test"
40-
python_functions="test"
39+
python_classes = "Test"
40+
python_functions = "test"
4141

4242
addopts = [
4343
"-rfExXw",
4444
"--strict",
4545
"--doctest-modules"
46-
]
46+
]

0 commit comments

Comments
 (0)