Skip to content

Commit 93660c3

Browse files
jborean93jborean93
committed
Update CI and Project Structure
Updates the CI and project structure to perform better tests and conform to more modern practices when it comes to Python projects. Also bumps the version to 1.3.0 in preparation for the next release. Signed-off-by: Jordan Borean <[email protected]>
1 parent f8f4011 commit 93660c3

File tree

13 files changed

+428
-349
lines changed

13 files changed

+428
-349
lines changed

‎.github/workflows/build.yml‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎.github/workflows/ci.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Test requests-gssapi
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
pull_request:
8+
branches:
9+
- main
10+
11+
release:
12+
types:
13+
- published
14+
15+
jobs:
16+
build:
17+
name: build sdist and wheel
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: build sdist and wheel
23+
run: |
24+
set -ex
25+
26+
python -m pip install build
27+
python -m build
28+
29+
- uses: actions/upload-artifact@v4
30+
with:
31+
name: artifact
32+
path: ./dist/*
33+
34+
test:
35+
name: test
36+
needs:
37+
- build
38+
runs-on: ubuntu-latest
39+
strategy:
40+
fail-fast: false
41+
matrix:
42+
python-version:
43+
- "3.8"
44+
- "3.9"
45+
- "3.10"
46+
- "3.11"
47+
- "3.12"
48+
49+
steps:
50+
- uses: actions/checkout@v4
51+
52+
- uses: actions/setup-python@v5
53+
with:
54+
python-version: ${{ matrix.python-version }}
55+
56+
- uses: actions/download-artifact@v4
57+
with:
58+
name: artifact
59+
path: ./dist
60+
61+
- name: Test
62+
shell: bash
63+
run: |
64+
set -ex
65+
66+
TOX_PYTHON=py$( echo '${{ matrix.python-version }}' | tr -d . )
67+
68+
sudo apt update
69+
sudo apt install -y libkrb5-dev
70+
71+
python -Im pip install tox
72+
python -Im tox run \
73+
-f sanity \
74+
-f "${TOX_PYTHON}" \
75+
--installpkg dist/*.whl
76+
env:
77+
PYTEST_ADDOPTS: --color=yes --junitxml junit/test-results.xml
78+
79+
publish:
80+
name: publish
81+
needs:
82+
- test
83+
runs-on: ubuntu-latest
84+
permissions:
85+
# IMPORTANT: this permission is mandatory for trusted publishing
86+
id-token: write
87+
88+
steps:
89+
- uses: actions/download-artifact@v4
90+
with:
91+
name: artifact
92+
path: ./dist
93+
94+
- name: Publish
95+
if: startsWith(github.event.release.tag_name, 'v')
96+
uses: pypa/gh-action-pypi-publish@release/v1

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
env/
44
build/
55
dist/
6+
.tox/
67
requests_gssapi.egg-info/
78

‎HISTORY.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
History
22
=======
33

4-
FUTURE: TBD
4+
1.3.0: 2024-02-16
55
-----------
66
- Drop flag for out of sequence detection
77
- Use SPNEGO mechanism by default
8+
- Fix ``SanitizedResponse.content`` to be ``bytes`` which reflects the base type
9+
- Migrated project to a ``src`` layout setup and a ``PEP 621`` compliant build, this should have no impact on end users
810

911
1.2.3: 2021-02-08
1012
-----------------

‎pyproject.toml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
[build-system]
2+
requires = [
3+
"setuptools >= 61.0.0", # Support for setuptools config in pyproject.toml
4+
]
5+
build-backend = "setuptools.build_meta"
6+
7+
[project]
8+
name = "requests-gssapi"
9+
description = "A GSSAPI authentication handler for python-requests"
10+
readme = "README.rst"
11+
requires-python = ">=3.8"
12+
license = { file = "LICENSE" }
13+
authors = [
14+
{ name = "Robbie Harwood", email = "[email protected]" },
15+
{ name = "Ian Cordasco" },
16+
{ name = "Cory Benfield" },
17+
{ name = "Michael Komitee" },
18+
]
19+
keywords = ["ansible", "debug", "lsp", "dap"]
20+
classifiers = [
21+
"License :: OSI Approved :: ISC License (ISCL)",
22+
"Programming Language :: Python :: 3",
23+
"Programming Language :: Python :: 3.8",
24+
"Programming Language :: Python :: 3.9",
25+
"Programming Language :: Python :: 3.10",
26+
"Programming Language :: Python :: 3.11",
27+
"Programming Language :: Python :: 3.12",
28+
]
29+
dependencies = [
30+
"requests >= 1.1.0",
31+
"gssapi",
32+
]
33+
dynamic = ["version"]
34+
35+
[project.urls]
36+
homepage = "https://github.com/pythongssapi/requests-gssapi"
37+
38+
[project.optional-dependencies]
39+
dev = [
40+
"black == 24.2.0",
41+
"isort == 5.13.2",
42+
"pytest",
43+
"tox >= 4.0.0",
44+
]
45+
46+
[tool.setuptools]
47+
include-package-data = true
48+
49+
[tool.setuptools.dynamic]
50+
version = { attr = "requests_gssapi.__version__" }
51+
52+
[tool.setuptools.packages.find]
53+
where = ["src"]
54+
55+
[tool.black]
56+
line-length = 120
57+
include = '\.pyi?$'
58+
exclude = '''
59+
/(
60+
\.git
61+
| \.hg
62+
| \.mypy_cache
63+
| \.tox
64+
| \.venv
65+
| _build
66+
| buck-out
67+
| build
68+
| dist
69+
)/
70+
'''
71+
72+
[tool.isort]
73+
profile = "black"
74+
75+
[tool.pytest.ini_options]
76+
addopts = "--import-mode=importlib"
77+
testpaths = "tests"
78+
junit_family = "xunit2"
79+
80+
[tool.tox]
81+
legacy_tox_ini = """
82+
[tox]
83+
env_list =
84+
sanity
85+
py3{8,9,10,11,12}-tests
86+
min_version = 4.0
87+
88+
[testenv]
89+
package = wheel
90+
wheel_build_env = .pkg
91+
92+
extras =
93+
dev
94+
install_command = python -Im pip install --no-compile {opts} {packages}
95+
96+
passenv =
97+
PYTEST_ADDOPTS
98+
99+
commands =
100+
sanity: python -m black . --check
101+
sanity: python -m isort . --check-only
102+
103+
tests: python -m pytest -v
104+
"""

‎requirements.txt‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎setup.cfg‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎setup.py‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎requests_gssapi/__init__.py‎ renamed to ‎src/requests_gssapi/__init__.py‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,22 @@
1212
1313
The entire `requests.api` should be supported.
1414
"""
15+
1516
import logging
1617

17-
from .gssapi_ import HTTPSPNEGOAuth, SPNEGO, REQUIRED, OPTIONAL, DISABLED # noqa
18+
from .compat import HTTPKerberosAuth, NullHandler
1819
from .exceptions import MutualAuthenticationError
19-
from .compat import NullHandler, HTTPKerberosAuth
20+
from .gssapi_ import DISABLED, OPTIONAL, REQUIRED, SPNEGO, HTTPSPNEGOAuth # noqa
2021

2122
logging.getLogger(__name__).addHandler(NullHandler())
2223

23-
__all__ = ('HTTPSPNEGOAuth', 'HTTPKerberosAuth', 'MutualAuthenticationError',
24-
'SPNEGO', 'REQUIRED', 'OPTIONAL', 'DISABLED')
25-
__version__ = '1.2.3'
24+
__all__ = (
25+
"HTTPSPNEGOAuth",
26+
"HTTPKerberosAuth",
27+
"MutualAuthenticationError",
28+
"SPNEGO",
29+
"REQUIRED",
30+
"OPTIONAL",
31+
"DISABLED",
32+
)
33+
__version__ = "1.3.0"

0 commit comments

Comments
 (0)