Skip to content

Commit a98a47b

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Merge remote-tracking branch 'skeleton/main' into release-prep-v30.4.2
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
2 parents 5fb0cbd + c1002c2 commit a98a47b

31 files changed

+658
-275
lines changed

‎.github/workflows/docs-ci.yml‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,29 @@ on: [push, pull_request]
44

55
jobs:
66
build:
7-
runs-on: ubuntu-22.04
7+
runs-on: ubuntu-24.04
88

99
strategy:
1010
max-parallel: 4
1111
matrix:
12-
python-version: [3.9]
12+
python-version: [3.13]
1313

1414
steps:
1515
- name: Checkout code
16-
uses: actions/checkout@v3
16+
uses: actions/checkout@v4
1717

1818
- name: Set up Python ${{ matrix.python-version }}
19-
uses: actions/setup-python@v4
19+
uses: actions/setup-python@v5
2020
with:
2121
python-version: ${{ matrix.python-version }}
2222

2323
- name: Install Dependencies
24-
run: pip install -e .[docs]
24+
run: ./configure --dev
2525

26-
- name: Check Sphinx Documentation build minimally
27-
working-directory: ./docs
28-
run: python3 -m sphinx -E -W source build
26+
- name: Check documentation and HTML for errors and dead links
27+
run: make docs-check
2928

30-
- name: Check for documentation style errors
31-
working-directory: ./docs
32-
run: ./scripts/doc8_style_check.sh
29+
- name: Check documentation for style errors
30+
run: make doc8
3331

3432

‎.github/workflows/pypi-release.yml‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,21 @@ jobs:
2626
steps:
2727
- uses: actions/checkout@v4
2828
- name: Set up Python
29-
uses: actions/setup-python@v4
29+
uses: actions/setup-python@v5
3030
with:
31-
python-version: 3.9
31+
python-version: 3.12
3232

33-
- name: Install pypa/build
34-
run: python -m pip install build --user
33+
- name: Install pypa/build and twine
34+
run: python -m pip install --user --upgrade build twine pkginfo
3535

3636
- name: Build a binary wheel and a source tarball
37-
run: python -m build --sdist --wheel --outdir dist/
37+
run: python -m build --sdist --outdir dist/
38+
39+
- name: Validate wheel and sdis for Pypi
40+
run: python -m twine check dist/*
3841

3942
- name: Upload built archives
40-
uses: actions/upload-artifact@v3
43+
uses: actions/upload-artifact@v4
4144
with:
4245
name: pypi_archives
4346
path: dist/*
@@ -54,13 +57,13 @@ jobs:
5457

5558
steps:
5659
- name: Download built archives
57-
uses: actions/download-artifact@v3
60+
uses: actions/download-artifact@v4
5861
with:
5962
name: pypi_archives
6063
path: dist
6164

6265
- name: Create GH release
63-
uses: softprops/action-gh-release@v1
66+
uses: softprops/action-gh-release@v2
6467
with:
6568
draft: true
6669
files: dist/*
@@ -74,7 +77,7 @@ jobs:
7477

7578
steps:
7679
- name: Download built archives
77-
uses: actions/download-artifact@v3
80+
uses: actions/download-artifact@v4
7881
with:
7982
name: pypi_archives
8083
path: dist

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,5 @@ tcl
7373
# Ignore Jupyter Notebook related temp files
7474
.ipynb_checkpoints/
7575
/.tox/
76+
/.ruff_cache/
77+
.env

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ python:
2626
- method: pip
2727
path: .
2828
extra_requirements:
29-
- docs
29+
- dev

‎AUTHORS.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ The following organizations or individuals have contributed to this code:
88
- Jono Yang @JonoYang
99
- Max Mehl @mxmehl
1010
- nexB Inc. @nexB
11+
- Pablo Castellazzi @pcastellazzi
1112
- Peter Kolbus @pkolbus
1213
- Philippe Ombredanne @pombredanne
1314
- Sebastian Schuberth @sschuberth
1415
- Steven Esser @majurg
1516
- Thomas Druez @tdruez
17+
- Uwe L. Korn @xhochy

‎MANIFEST.in‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
graft src
2+
graft docs
3+
graft etc
24

35
include *.LICENSE
46
include NOTICE
57
include *.ABOUT
68
include *.toml
79
include *.yml
810
include *.rst
11+
include *.png
912
include setup.*
1013
include configure*
1114
include requirements*
12-
include .git*
15+
include .dockerignore
16+
include .gitignore
17+
include .readthedocs.yml
18+
include manage.py
19+
include Dockerfile*
20+
include Makefile
21+
include MANIFEST.in
1322

14-
global-exclude *.py[co] __pycache__ *.*~
23+
include .VERSION
1524

25+
global-exclude *.py[co] __pycache__ *.*~

‎Makefile‎

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,33 @@ PYTHON_EXE?=python3
1313
VENV=venv
1414
ACTIVATE?=. ${VENV}/bin/activate;
1515

16-
dev:
17-
@echo "-> Configure the development envt."
18-
./configure --dev
1916

20-
isort:
21-
@echo "-> Apply isort changes to ensure proper imports ordering"
22-
${VENV}/bin/isort --sl -l 100 src tests setup.py
17+
conf:
18+
@echo "-> Install dependencies"
19+
./configure
2320

24-
black:
25-
@echo "-> Apply black code formatter"
26-
${VENV}/bin/black -l 100 src tests setup.py
21+
dev:
22+
@echo "-> Configure and install development dependencies"
23+
./configure --dev
2724

2825
doc8:
2926
@echo "-> Run doc8 validation"
30-
@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
27+
@${ACTIVATE} doc8 --quiet docs/ *.rst
3128

32-
valid: isort black
29+
valid:
30+
@echo "-> Run Ruff format"
31+
@${ACTIVATE} ruff format
32+
@echo "-> Run Ruff linter"
33+
@${ACTIVATE} ruff check --fix
3334

3435
check:
35-
@echo "-> Run pycodestyle (PEP8) validation"
36-
@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
37-
@echo "-> Run isort imports ordering validation"
38-
@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests .
39-
@echo "-> Run black validation"
40-
@${ACTIVATE} black --check --check -l 100 src tests setup.py
36+
@echo "-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)"
37+
@${ACTIVATE} ruff check
38+
@echo "-> Run Ruff format validation"
39+
@${ACTIVATE} ruff format --check
40+
@$(MAKE) doc8
41+
@echo "-> Run ABOUT files validation"
42+
@${ACTIVATE} about check etc/
4143

4244
clean:
4345
@echo "-> Clean the Python env"
@@ -49,6 +51,10 @@ test:
4951

5052
docs:
5153
rm -rf docs/_build/
52-
@${ACTIVATE} sphinx-build docs/ docs/_build/
54+
@${ACTIVATE} sphinx-build docs/source docs/_build/
55+
56+
docs-check:
57+
@${ACTIVATE} sphinx-build -E -W -b html docs/source docs/_build/
58+
@${ACTIVATE} sphinx-build -E -W -b linkcheck docs/source docs/_build/
5359

54-
.PHONY: conf dev check valid black isort clean test docs
60+
.PHONY: conf dev check valid clean test docs docs-check

‎azure-pipelines.yml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
################################################################################
66

77
jobs:
8+
- template: etc/ci/azure-posix.yml
9+
parameters:
10+
job_name: run_code_checks
11+
image_name: ubuntu-24.04
12+
python_versions: ['3.13']
13+
test_suites:
14+
all: make check
15+
816
- template: etc/ci/azure-posix.yml
917
parameters:
1018
job_name: ubuntu22_cpython
@@ -39,8 +47,8 @@ jobs:
3947

4048
- template: etc/ci/azure-win.yml
4149
parameters:
42-
job_name: win2019_cpython
43-
image_name: windows-2019
50+
job_name: win2025_cpython
51+
image_name: windows-2025
4452
python_versions: ["3.9", "3.10", "3.11", "3.12", "3.13"]
4553
test_suites:
4654
all: venv\Scripts\pytest -n 2 -vvs

‎configure‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,13 @@ CLI_ARGS=$1
2929

3030
# Requirement arguments passed to pip and used by default or with --dev.
3131
REQUIREMENTS="--editable . --constraint requirements.txt"
32-
DEV_REQUIREMENTS="--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
33-
DOCS_REQUIREMENTS="--editable .[docs] --constraint requirements.txt"
32+
DEV_REQUIREMENTS="--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
3433

3534
# where we create a virtualenv
3635
VIRTUALENV_DIR=venv
3736

3837
# Cleanable files and directories to delete with the --clean option
39-
CLEANABLE="build dist venv .cache .eggs"
38+
CLEANABLE="build dist venv .cache .eggs *.egg-info docs/_build/ pip-selfcheck.json"
4039

4140
# extra arguments passed to pip
4241
PIP_EXTRA_ARGS=" "
@@ -111,7 +110,7 @@ create_virtualenv() {
111110
fi
112111

113112
$PYTHON_EXECUTABLE "$VIRTUALENV_PYZ" \
114-
--wheel embed --pip embed --setuptools embed \
113+
--pip embed --setuptools embed \
115114
--seeder pip \
116115
--never-download \
117116
--no-periodic-update \
@@ -168,6 +167,7 @@ clean() {
168167
for cln in $CLEANABLE;
169168
do rm -rf "${CFG_ROOT_DIR:?}/${cln:?}";
170169
done
170+
find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
171171
set +e
172172
exit
173173
}
@@ -185,7 +185,6 @@ while getopts :-: optchar; do
185185
help ) cli_help;;
186186
clean ) find_python && clean;;
187187
dev ) CFG_REQUIREMENTS="$DEV_REQUIREMENTS";;
188-
docs ) CFG_REQUIREMENTS="$DOCS_REQUIREMENTS";;
189188
esac;;
190189
esac
191190
done

‎configure.bat‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727

2828
@rem # Requirement arguments passed to pip and used by default or with --dev.
2929
set "REQUIREMENTS=--editable . --constraint requirements.txt"
30-
set "DEV_REQUIREMENTS=--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
31-
set "DOCS_REQUIREMENTS=--editable .[docs] --constraint requirements.txt"
30+
set "DEV_REQUIREMENTS=--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
3231

3332
@rem # where we create a virtualenv
3433
set "VIRTUALENV_DIR=venv"
@@ -76,9 +75,6 @@ if not "%1" == "" (
7675
if "%1" EQU "--dev" (
7776
set "CFG_REQUIREMENTS=%DEV_REQUIREMENTS%"
7877
)
79-
if "%1" EQU "--docs" (
80-
set "CFG_REQUIREMENTS=%DOCS_REQUIREMENTS%"
81-
)
8278
shift
8379
goto again
8480
)
@@ -114,7 +110,7 @@ if not exist "%CFG_BIN_DIR%\python.exe" (
114110

115111
if exist "%CFG_ROOT_DIR%\etc\thirdparty\virtualenv.pyz" (
116112
%PYTHON_EXECUTABLE% "%CFG_ROOT_DIR%\etc\thirdparty\virtualenv.pyz" ^
117-
--wheel embed --pip embed --setuptools embed ^
113+
--pip embed --setuptools embed ^
118114
--seeder pip ^
119115
--never-download ^
120116
--no-periodic-update ^
@@ -130,7 +126,7 @@ if not exist "%CFG_BIN_DIR%\python.exe" (
130126
)
131127
)
132128
%PYTHON_EXECUTABLE% "%CFG_ROOT_DIR%\%VIRTUALENV_DIR%\virtualenv.pyz" ^
133-
--wheel embed --pip embed --setuptools embed ^
129+
--pip embed --setuptools embed ^
134130
--seeder pip ^
135131
--never-download ^
136132
--no-periodic-update ^

0 commit comments

Comments
 (0)