Switch to pyproject.toml (#408)

* Switch to `pyproject.toml` Keep setuptools, remove Poetry. Remove references to pycodestyle, flake8 already runs it Make lint configurations consistent with each other Run black in CI Remove travis CI Remove pylint config, it is not enforced (can be added later) * Drop support for Python 3.6, update actions * Add black to dev deps * Fix deps specification
SAML-Toolkits · Jun 23, 2024 · 7658b88 · 7658b88
1 parent 2970d8e
commit 7658b88
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 317 deletions.
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,4 @@
+[flake8]
+ignore = E731,W504,E501
+max-complexity = 50
+max-line-length = 200
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -13,65 +13,64 @@ on:
 
 jobs:
   test_py3:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
         python-version:
-          - "3.6"
           - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
         restore-keys: |
           ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
         pip install -U setuptools
         sudo apt-get update -qq
-        sudo apt-get install -qq swig python-dev libxml2-dev libxmlsec1-dev
+        sudo apt-get install -qq swig libxml2-dev libxmlsec1-dev
         make install-req
         make install-test
     - name: Test
       run: make pytest
   lint:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     environment: CI
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: "3.12"
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
         restore-keys: |
           ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
         pip install -U setuptools
         sudo apt-get update -qq
-        sudo apt-get install -qq swig python-dev libxml2-dev libxmlsec1-dev
+        sudo apt-get install -qq swig libxml2-dev libxmlsec1-dev
         pip install --force-reinstall --no-binary lxml lxml
         make install-req
-        make install-test
+        make install-lint
     - name: Run linters
       run: |
-        make pycodestyle
         make flake8
+        make black
     - name: Run coveralls
       env:
         COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}

diff --git a/.travis.yml b/.travis.yml
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
@@ -1,10 +1,9 @@
 PIP=pip
+BLACK=black
 FLAKE8=flake8
 PYTEST=pytest
-PYCODESTYLE=pycodestyle
 COVERAGE=coverage
 COVERAGE_CONFIG=tests/coverage.rc
-PEP8_CONFIG=tests/pep8.rc
 MAIN_SOURCE=src/onelogin/saml2
 DEMOS=demo-django demo-flask demo-tornado demo_pyramid
 TESTS=tests/src/OneLogin/saml2_tests
@@ -14,19 +13,22 @@ install-req:
 	$(PIP) install .
 
 install-test:
-	$(PIP) install -e ".[test]" 
+	$(PIP) install -e ".[test]"
+
+install-lint:
+	$(PIP) install -e ".[lint]"
 
 pytest:
 	$(COVERAGE) run --source $(MAIN_SOURCE) --rcfile=$(COVERAGE_CONFIG) -m pytest
 	$(COVERAGE) report -m --rcfile=$(COVERAGE_CONFIG)
 
-pycodestyle:
-	$(PYCODESTYLE) --ignore=E501,E731,W504 $(SOURCES) --config=$(PEP8_CONFIG)
+black:
+	$(BLACK) $(SOURCES)
 
 flake8:
 	$(FLAKE8) $(SOURCES)
 
-clean: 
+clean:
 	rm -rf .pytest_cache/
 	rm -rf .eggs/
 	find . -type d -name "__pycache__" -exec rm -r {} +

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,19 @@
-[tool.poetry]
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
 name = "python3-saml"
 version = "1.16.0"
 description = "Saml Python Toolkit. Add SAML support to your Python software using this library"
-license = "Apache-2.0"
-authors = ["SAML-Toolkits <[email protected]>"]
-maintainers = ["Sixto Martin <[email protected]>"]
+license = {file = "LICENSE"}
+authors = [
+    {name = "SAML-Toolkits", email = "[email protected]"}
+]
+maintainers = [
+    {name = "Sixto Martin", email = "[email protected]"}
+]
 readme = "README.md"
-homepage = "https://saml.info"
-repository = "https://github.com/SAML-Toolkits/python3-saml"
 keywords = [
     "saml",
     "saml2",
@@ -17,71 +23,42 @@ keywords = [
     "identity",
 ]
 classifiers = [
-    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-packages = [
-    { include = "onelogin", from = "src" },
-    { include = "onelogin/saml2", from = "src" },
+dependencies = [
+    "lxml>=4.6.5,!=4.7.0",
+    "xmlsec>=1.3.9",
+    "isodate>=0.6.1",
 ]
+requires-python = ">=3.7"
 
-include = [
-    { path = "src/onelogin/saml2/schemas"},
-    { path = "tests", format = "sdist" }
-]
-
-[tool.poetry.urls]
+[project.urls]
+Homepage = "https://saml.info"
+Source = "https://github.com/SAML-Toolkits/python3-saml"
 "Bug Tracker" = "https://github.com/SAML-Toolkits/python3-saml/issues"
+Changelog = "https://github.com/SAML-Toolkits/python3-saml/blob/master/changelog.md"
 
-[tool.poetry.dependencies]
-python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
-lxml = ">=4.6.5, !=4.7.0"
-xmlsec = ">=1.3.9"
-isodate = ">=0.6.1"
-
-#[tool.poetry.group.dev]
-#optional = true
-
-#[tool.poetry.group.dev.dependencies]
-#black = "*"
-#isort = {version = "^5.10.1", extras = ["pyproject"]}
-flake8 = { version = ">=3.6.0, <=5.0.0", optional = true}
-#Flake8-pyproject = "^1.1.0.post0"
-#flake8-bugbear = "^22.8.23"
-#flake8-logging-format = "^0.7.5"
-#ipdb = "^0.13.9"
-
-#[tool.poetry.group.test.dependencies]
-pytest = { version = ">=4.6.11", optional = true}
-coverage = { version = ">=4.5.2", optional = true}
-#pylint = ">=1.9.4"
-
-[tool.poetry.extras]
-test = ["flake8", "pytest", "coverage"]
-
-#[tool.poetry.group.test]
-#optional = true
-
-#[tool.poetry.group.coverage]
-#optional = true
-
-#[tool.poetry.group.coverage.dependencies]
-#coverage = ">=4.5.2"
-#pytest-cov = "*"
-
-#[tool.poetry.group.docs]
-#optional = true
+[project.optional-dependencies]
+test = [
+    "coverage>=4.5.2",
+    "pytest>=4.6",
+]
+lint = [
+    "black==24.4.2",
+    "flake8>=3.6.0, <=5.0.0",
+]
 
-#[tool.poetry.group.docs.dependencies]
-#sphinx = "*"
+[tool.setuptools]
+package-dir = {"" = "src"}
 
-[build-system]
-requires = [
-  "poetry>=1.1.15",
-  "setuptools >= 40.1.0",
-  "wheel"
-]
-build-backend = "poetry.core.masonry.api"
+[tool.setuptools.package-data]
+"onelogin.saml2.schemas" = ["*.xsd"]
 
 [tool.pytest.ini_options]
 minversion = "4.6.11"
@@ -93,75 +70,11 @@ pythonpath = [
     "tests",
 ]
 
-[tool.coverage.run]
-branch = true
-source = ["src/onelogin/saml2"]
-
-[tool.coverage.report]
-exclude_lines = [
-  "pragma: no cover",
-  "def __repr__",
-  "def __str__",
-  "raise AssertionError",
-  "raise NotImplementedError",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-  "if typing.TYPE_CHECKING:",
-]
-ignore_errors = true
-
-[tool.coverage.html]
-directory = "cov_html"
-
-[tool.flake8]
-max-line-length = 210
-max-complexity = 22
-count = true
-show-source = true
-statistics = true
-disable-noqa = false
-# 'ignore' defaults to: E121,E123,E126,E226,E24,E704,W503,W504
-extend-ignore = [
-    'B904',
-    'B006',
-    'B950',
-    'B017',
-    'C901',
-    'E501',
-    'E731',
-]
-per-file-ignores = [
-    '__init__.py:F401',
-]
-# 'select' defaults to: E,F,W,C90
-extend-select = [
-    # * Default warnings reported by flake8-bugbear (B) -
-    #   https://github.com/PyCQA/flake8-bugbear#list-of-warnings
-    'B',
-    # * The B950 flake8-bugbear opinionated warnings -
-    #   https://github.com/PyCQA/flake8-bugbear#opinionated-warnings
-    'B9',
-]
-extend-exclude = [
-    '.github', '.gitlab',
-    '.Python', '.*.pyc', '.*.pyo', '.*.pyd', '.*.py.class', '*.egg-info',
-    'venv*', '.venv*', '.*_cache',
-    'lib', 'lib64', '.*.so',
-    'build', 'dist', 'sdist', 'wheels',
-]
-
 [tool.black]
 line-length = 200
-extend-exclude = '''
-# A regex preceded with ^/ will apply only to files and directories
-# in the root of the project.
-(
-    \.pytest_cache
-)
-'''
 
 [tool.isort]
-profile = 'black'
+profile = "black"
 # The 'black' profile means:
 #   multi_line_output = 3
 #   include_trailing_comma = true
@@ -179,7 +92,4 @@ honor_noqa = true
 atomic = true
 ignore_comments = true
 skip_gitignore = true
-src_paths = [
-    'src',
-    'tests',
-]
+src_paths = ['src']
diff --git a/setup.cfg b/setup.cfg