Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
129 commits
Select commit Hold shift + click to select a range
aeb2fd9
Change version to next .dev0
bskinn May 26, 2025
04dbcc0
Merge pull request #319 from bskinn/release-2.3.1.3
bskinn May 26, 2025
e14c8a3
Fix GitHub badge image link to an existing workflow file
bskinn May 30, 2025
115cbb9
Run core tests on pushes to main as well as PRs
bskinn May 30, 2025
7d52752
Update CHANGELOG
bskinn May 31, 2025
ae11a0e
Merge pull request #320 from bskinn/fix-github-badge
bskinn May 31, 2025
fe832fd
Add initial code and inv
bskinn Aug 29, 2024
3557bd3
Add .gitattributes line for configuring textconv
bskinn Aug 30, 2024
419f684
Commit small change to objects_textconv.inv
bskinn Aug 30, 2024
e7e84c3
Tweak the -textconv CLI help text
bskinn Dec 22, 2025
4498e10
Update CLI runner to dispatch to either core or textconv CLI
bskinn Dec 22, 2025
19f06ff
Add initial testconv test file
bskinn Dec 22, 2025
d3a70fc
Add 'textconv' pytest marker
bskinn Dec 24, 2025
71b51f6
Finish TestFail class for textconv CLI
bskinn Dec 24, 2025
7363691
Adjust print_stderr() to work with textconv
bskinn Dec 24, 2025
6c47b57
Add initial fixtures_http.py
bskinn Dec 24, 2025
230cd6a
Move conftest.py into tests/
bskinn Dec 24, 2025
86e8cd2
Update paths inside conftest.py
bskinn Dec 24, 2025
7338ba8
Adjust tox envs for conftest.py now being inside tests/
bskinn Dec 24, 2025
892208d
Add HTTP/HTTPS comments to test_api_inventory_known_header_required()
bskinn Dec 24, 2025
36d93e5
Remove extra newline
bskinn Dec 24, 2025
c7b3a58
Replace GitHub remote URL with local-server URL
bskinn Dec 24, 2025
09c9640
Switch resource_url fixture to session-scope
bskinn Dec 24, 2025
a9e37bf
Add 'tests' "package" to first-party in flake config
bskinn Dec 24, 2025
f2d56f6
Update external-remote URL-load check test
bskinn Dec 24, 2025
f784a6d
Convert --testall URL API imports to use local server
bskinn Dec 24, 2025
b802899
Convert nonlocal CLI tests to use local server
bskinn Dec 24, 2025
543e092
Remove Django-specific URL test
bskinn Dec 24, 2025
a07f2a5
Update supported Python range to 3.10-3.14
bskinn Dec 24, 2025
551e5a0
Expand on a comment for historical info
bskinn Dec 24, 2025
4c91212
Bump active dev Sphinx version
bskinn Dec 24, 2025
a42a01b
Convert docs 'suggest' call from Github to RTD
bskinn Dec 24, 2025
f4726e8
Fix inventory filename
bskinn Dec 24, 2025
f77ddf2
Tweak a couple of tests comments
bskinn Dec 24, 2025
66e52b1
Drop dev-pin Sphinx back down to 8.1.3
bskinn Dec 24, 2025
d0fc65b
Switch fixture to 'localhost' from '127.0.0.1'
bskinn Dec 24, 2025
201caa4
Skip reverse DNS lookup when logging in testing HTTP server
bskinn Dec 24, 2025
0508f78
Revert "Skip reverse DNS lookup when logging in testing HTTP server"
bskinn Dec 24, 2025
8314969
Switch local HTTP server to not do rDNS lookup on startup
bskinn Dec 24, 2025
a47d0e3
Generalize text search in test_cli_noargs_shows_help()
bskinn Dec 24, 2025
0413fb1
Update Sphinx pin note in requirements-dev.txt
bskinn Dec 24, 2025
c7a1491
Update CHANGELOG
bskinn Dec 24, 2025
0d9d181
[UPKEEP] Merge pull request #325 from bskinn/local-http-testing
bskinn Dec 24, 2025
f136f63
Switch to using isort for import formatting
bskinn Dec 24, 2025
469b052
Add version reports to tox black, flake envs
bskinn Dec 24, 2025
b91c09f
Add {posargs} to flake8 tox envs
bskinn Dec 24, 2025
f87899c
Remove flake8 from dev req'ts
bskinn Dec 25, 2025
018b59a
Remove flake8-import-order config from tox.ini
bskinn Dec 25, 2025
492ca5d
Add flake8-isort to flake8 req'ts
bskinn Dec 25, 2025
8a133e4
Run isort
bskinn Dec 25, 2025
3e9f9bc
Update CHANGELOG
bskinn Dec 25, 2025
2432d66
[UPKEEP] Merge pull request #327 from bskinn/lints-admin
bskinn Dec 25, 2025
d0c689b
Merge branch 'main' into textconv-alt
bskinn Dec 25, 2025
12518da
Empty textconv TestConverGood
bskinn Dec 25, 2025
16b2635
Add test matching core and textconv stdout conversion
bskinn Dec 25, 2025
ec48e53
Convert textconv parser's 'version' report to 'version' action
bskinn Dec 25, 2025
63c4d6e
Convert some basic CLI-behavior tests
bskinn Dec 25, 2025
b7c1556
Remove last old tests
bskinn Dec 25, 2025
c4a8b71
Remove remainder of flake8-import-order config from tox.ini
bskinn Dec 28, 2025
fbb1770
Add descriptions to tox envs and make linkcheck Linux-only
bskinn Dec 28, 2025
d1ce02c
Add 'sphobjinv' explicitly to convert/suggest docs page headings
bskinn Dec 28, 2025
73f76fd
Add CLI entrypoint replaces in conf.py rst_epilog
bskinn Dec 28, 2025
9bebf6f
Add soi_root.rst
bskinn Dec 28, 2025
2c50eeb
Remove 'core' "sphobjinv" entrypoint options from index.rst
bskinn Dec 28, 2025
9fc04f0
Rename page "API" -> "API Reference"
bskinn Dec 28, 2025
2806854
Revise headings of convert & suggest subcommand pages
bskinn Dec 28, 2025
e2b9ac3
Rework majority of CLI Usage index.rst
bskinn Dec 28, 2025
f37dabb
Start work drafting textconv.rst
bskinn Dec 29, 2025
bc03a22
Remove/add some replace:: in conf.py rst_epilog
bskinn Dec 29, 2025
508659a
Further add/revise to index.rst & textconv.rst
bskinn Dec 29, 2025
0dc0b86
Add on-the-fly Git textconv config to textconv.rst
bskinn Dec 29, 2025
c874091
Handle the soi version import properly in conf.py
bskinn Dec 30, 2025
f6604b4
Remove the CLI implementation reference pages
bskinn Dec 30, 2025
13da13e
Remove reST replace:: markup from CLI docstrings
bskinn Dec 30, 2025
621e6ef
Add workflow to error at release on any ##VER## in docs
bskinn Jan 6, 2026
94a313d
Switch to looking for a marker that's not there, to test
bskinn Jan 6, 2026
f3e438b
Restore workflow to non-draft, release-only w/correct search term
bskinn Jan 6, 2026
a7a3ea5
Rename workflow job
bskinn Jan 6, 2026
ae3100f
Rearrange & re-label some textconv entrypoint tests
bskinn Jan 6, 2026
2807e41
Update CHANGELOG
bskinn Jan 6, 2026
58a79f5
Use enum value in run_cmdline_test func
bskinn Jan 6, 2026
9b6415f
[MINOR] Merge pull request #331 from bskinn/textconv-alt
bskinn Jan 6, 2026
ca05fbc
Update some CLI test URLs to https://...
bskinn Jan 11, 2026
3b9c000
Add free-threaded 3.13 and 3.14 to tox
bskinn Jan 11, 2026
852b89f
Ignore implicit-cleanup ResourceWarnings in two CLI tests
bskinn Jan 12, 2026
b812608
Remove the problematic Sphinx 3.x test
bskinn Jan 12, 2026
082569e
Update http -> https and some docs bits
bskinn Jan 17, 2026
fbc1666
Update CHANGELOG
bskinn Jan 17, 2026
7a5aec7
Merge pull request #333 from bskinn/update-test-harness
bskinn Jan 18, 2026
ac33104
Bump to Ubuntu 24.04 for RTD builds
bskinn Mar 14, 2026
cb53f5c
Freshen links into Sphinx source
bskinn Mar 14, 2026
fd03764
Update numpy example in README
bskinn Mar 14, 2026
f188bcc
Freshen/update some docs bits
bskinn Mar 14, 2026
86ca321
Bump package to 2.4.dev0 and update README example
bskinn Mar 15, 2026
40109b0
Specify Python 3.13 for black, and blacken
bskinn Mar 15, 2026
2a0ebba
Bump minimum jsonschema to v3.1.1
bskinn Mar 15, 2026
ade2a20
Update sphinx and attrs invs
bskinn Mar 16, 2026
2014ccf
Update JSON and TXT attrs invs, too
bskinn Mar 16, 2026
77613b2
Update test checks to match new attrs inventory
bskinn Mar 16, 2026
7a76358
Update README doctest examples
bskinn Mar 16, 2026
573c255
Update Pepy badge link
bskinn Mar 16, 2026
1297e6c
Reset and refactor version override in setup.py
bskinn Mar 16, 2026
7ae75a1
Update copyright statements and year ranges
bskinn Mar 16, 2026
f9582a9
Modernize package license metadata
bskinn Mar 20, 2026
454328a
Substitute in 2.4 for ##VER## tags
bskinn Mar 20, 2026
cdf1ee4
Apply version and date to CHANGELOG
bskinn Mar 20, 2026
19bcd72
Update CONTRIBUTING.md
bskinn Mar 20, 2026
1f852e8
Bump release date
bskinn Mar 20, 2026
13376fc
Fix line length in parser.py
bskinn Mar 20, 2026
085356e
Update attrs versions in doctests
bskinn Mar 20, 2026
83acf02
Bump checkout/setup-python actions versions and de-persist creds
bskinn Mar 20, 2026
1207609
Pin actions to SHAs
bskinn Mar 22, 2026
432603e
Update actions to full SHA refs
bskinn Mar 22, 2026
a5db0c1
Update doctests to new attrs version
bskinn Mar 22, 2026
44ccac6
Update test-tests with new attrs content
bskinn Mar 22, 2026
2467703
Fix Sphinx inv objects check for multiple sphinx inventories
bskinn Mar 22, 2026
440c685
Refine sphinx inv filter
bskinn Mar 22, 2026
d2402af
Add missing newline in test_api_good.py
bskinn Mar 22, 2026
4bf131f
Remove flake8 extensions test
bskinn Mar 22, 2026
3c40df2
Add some pragma: no cover
bskinn Mar 22, 2026
b49356b
Don't cover setup.py
bskinn Mar 22, 2026
40ed2d7
Remove obsolete fixture for doc scratch
bskinn Mar 22, 2026
d3bcb83
Update CHANGELOG
bskinn Mar 22, 2026
ae31b9d
Add 'build' tox env
bskinn Mar 23, 2026
77ae00b
Remove superfluous packages from req'ts files
bskinn Mar 23, 2026
823f452
Add tests/resource/objects_pdfminer* to MANIFEST.in
bskinn Mar 23, 2026
c841682
Fix to correct reST italics in textconv.rst
bskinn Mar 23, 2026
d42583c
Update CHANGELOG & fix typo
bskinn Mar 23, 2026
f4a2a28
Bump v2.4 date in CHANGELOG
bskinn Mar 23, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ source =
omit =
# Don't worry about covering vendored libraries
src/sphobjinv/_vendored/*
# Not part of the test suite
setup.py

[report]
exclude_lines =
Expand Down
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
tests/resource/objects_mkdoc_zlib0.inv binary
tests/resource/objects_attrs.txt binary
*.inv diff=objects_inv
15 changes: 10 additions & 5 deletions .github/workflows/all_core_tests.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
name: 'ALL: Run tests on Python 3.12'
name: 'ALL: Run tests on Python 3.13'

on:
- pull_request
pull_request:
push:
branches:
- main

jobs:
current_python_tests:
Expand All @@ -16,12 +19,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-ci.txt

Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/ready_doctest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-ci.txt

Expand Down
16 changes: 10 additions & 6 deletions .github/workflows/ready_linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-flake8.txt

Expand All @@ -50,12 +52,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-interrogate.txt

Expand Down
10 changes: 6 additions & 4 deletions .github/workflows/ready_test_matrix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,19 @@ jobs:
strategy:
matrix:
os: ['windows-latest', 'ubuntu-latest', 'macos-latest']
py: ['3.9', '3.10', '3.11', '3.13']
py: ['3.10', '3.11', '3.12', '3.14']
include:
- os: 'macos-latest'
py: '3.12'
py: '3.13'

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: ${{ matrix.py }}
cache: 'pip'
Expand Down
10 changes: 6 additions & 4 deletions .github/workflows/ready_test_nonloc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:

jobs:
python_os_test_matrix:
name: ${{ matrix.os }} python 3.12
name: ${{ matrix.os }} python 3.13
runs-on: ${{ matrix.os }}
concurrency:
group: ${{ github.workflow }}-${{ matrix.os }}-${{ github.ref }}
Expand All @@ -25,12 +25,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-ci.txt

Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/release_check_sdist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-dev.txt

Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/release_doc_warnings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-rtd.txt

Expand Down
30 changes: 30 additions & 0 deletions .github/workflows/release_enusre_no_ver_markers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 'RELEASE: Check docs source files'

on:
pull_request:
types:
- opened
- reopened
- synchronize
- ready_for_review
branches:
- stable

jobs:
ver_placeholder_search:
name: 'have no ##VER## markers'
runs-on: 'ubuntu-latest'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
if: ${{ !github.event.pull_request.draft }}

steps:
- name: Check out repo
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Error if any markers found
run: |
grep -ri '#VER#' doc/source && exit 1 || exit 0
8 changes: 5 additions & 3 deletions .github/workflows/release_flake8_noqa_nofail.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-ci.txt

Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/release_readme_doctest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: requirements-ci.txt

Expand Down
12 changes: 7 additions & 5 deletions .github/workflows/release_test_file_coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@ jobs:

steps:
- name: Check out repo
uses: actions/checkout@v4
uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
with:
persist-credentials: false

- name: Install Python
uses: actions/setup-python@v5
uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
with:
python-version: '3.12'
python-version: '3.13'
cache: 'pip'
cache-dependency-path: |
requirements-ci.txt
requirements-flake8.txt

- name: Install CI requirements
run: pip install -r requirements-ci.txt -r requirements-flake8.txt
run: pip install -r requirements-ci.txt

- name: Build docs & ensure scratch
run: |
Expand All @@ -42,7 +44,7 @@ jobs:
mkdir scratch

- name: Run pytest covering entire project tree
run: pytest --cov=. --nonloc --flake8_ext
run: pytest --cov=. --nonloc

- name: Check 100% test code execution
run: coverage report --include="tests/*" --fail-under=100
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ version: 2

# Build and VM configuration
build:
os: 'ubuntu-22.04'
os: 'ubuntu-24.04'
tools:
python: '3.12'
python: '3.13'

# Python requirements
python:
Expand Down
Loading