🔧 MAINTAIN: Move from setuptools to flit for package build (#58)

.github/workflows/ci.yml

@@ -68,12 +68,12 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: 3.8
-    - name: Build package
+    - name: install flit
       run: |
-        pip install wheel
-        python setup.py sdist bdist_wheel
-    - name: Publish
-      uses: pypa/gh-action-pypi-publish@v1.1.0
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_KEY }}
+        pip install flit~=3.4
+    - name: Build and publish
+      run: |
+        flit publish
+      env:
+        FLIT_USERNAME: __token__
+        FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}

.pre-commit-config.yaml

@@ -11,27 +11,20 @@ exclude: >
 repos:
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.2.0
     hooks:
     - id: check-json
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
 
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.47"
-    hooks:
-    - id: check-manifest
-      args: [--no-build-isolation]
-      additional_dependencies: [setuptools>=46.4.0]
-
   - repo: https://github.com/pycqa/isort
     rev: 5.10.1
     hooks:
     - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 22.3.0
     hooks:
     - id: black
 
@@ -42,16 +35,11 @@ repos:
       additional_dependencies: [flake8-bugbear==21.3.1]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.910-1
+    rev: v0.942
     hooks:
     - id: mypy
       additional_dependencies: []
 
-  - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.20.0
-    hooks:
-    - id: setup-cfg-fmt
-
   - repo: local
     hooks:
     - id: css

.readthedocs.yml

@@ -1,7 +1,7 @@
 version: 2
 
 python:
-  version: "3"
+  version: "3.8"
   install:
       - method: pip
         path: .

pyproject.toml

@@ -1,7 +1,70 @@
 [build-system]
-requires = ["setuptools>=46.4.0", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["flit_core >=3.4,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "sphinx_design"
+dynamic = ["version"]
+description = "A sphinx extension for designing beautiful, view size responsive web components."
+authors = [{name = "Chris Sewell", email = "chrisj_sewell@hotmail.com"}]
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Markup",
+    "Topic :: Text Processing :: Markup :: Markdown",
+    "Topic :: Text Processing :: Markup :: reStructuredText",
+]
+keywords = ["sphinx", "extension", "material design", "web components"]
+requires-python = ">=3.7"
+dependencies = ["sphinx>=3,<5"]
+
+[project.urls]
+Homepage = "https://github.com/executablebooks/sphinx-design"
+Documentation = "https://sphinx-design.readthedocs.io"
+
+[project.optional-dependencies]
+code_style = ["pre-commit~=2.12"]
+rtd = ["myst-parser~=0.17.0"]
+testing = [
+    "myst-parser~=0.17.0",
+    "pytest~=6.2",
+    "pytest-cov",
+    "pytest-regressions",
+]
+theme_furo = ["furo==2022.04.07"]
+theme_pydata = ["pydata-sphinx-theme~=0.8.1"]
+theme_rtd = ["sphinx-rtd-theme~=1.0"]
+theme_sbt = ["sphinx-book-theme~=0.3.0"]
+
+[tool.flit.sdist]
+exclude = [
+    "docs/",
+    "style/",
+    "tests/",
+]
+
+[tool.mypy]
+show_error_codes = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+no_implicit_optional = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = ["docutils.*"]
+ignore_missing_imports = true
 
 [tool.isort]
 profile = "black"
 src_paths = ["sphinx_design", "tests"]
+force_sort_within_sections = true

sphinx_design/extension.py

@@ -1,12 +1,7 @@
 import hashlib
+import importlib.resources as resources
 from pathlib import Path
 
-try:
-    import importlib.resources as resources
-except ImportError:
-    # python < 3.7
-    import importlib_resources as resources  # type: ignore[no-redef]
-
 from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx.application import Sphinx

sphinx_design/icons.py

@@ -1,14 +1,9 @@
+from functools import lru_cache
+import importlib.resources as resources
 import json
 import re
-from functools import lru_cache
 from typing import Any, Dict, List, Optional, Sequence, Tuple
 
-try:
-    import importlib.resources as resources
-except ImportError:
-    # python < 3.7
-    import importlib_resources as resources  # type: ignore[no-redef]
-
 from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx.application import Sphinx

tests/conftest.py

@@ -2,8 +2,8 @@
 from pathlib import Path
 from typing import Any, Dict, Optional
 
-import pytest
 from docutils import nodes
+import pytest
 from sphinx.testing.path import path as sphinx_path
 from sphinx.testing.util import SphinxTestApp
 

tests/test_snippets.py

@@ -34,8 +34,6 @@ def test_snippets_rst(
     write_assets(builder.src_path)
     builder.build()
     pformat = builder.get_doctree("index").pformat()
-    # fixed in https://github.com/executablebooks/MyST-Parser/pull/465
-    pformat = pformat.replace('<bullet_list bullet="-">', "<bullet_list>")
     file_regression.check(
         pformat,
         basename=f"snippet_pre_{path.name[:-len(path.suffix)]}",
@@ -81,8 +79,6 @@ def test_snippets_rst_post(
     write_assets(builder.src_path)
     builder.build()
     pformat = builder.get_doctree("index", post_transforms=True).pformat()
-    # fixed in https://github.com/executablebooks/MyST-Parser/pull/465
-    pformat = pformat.replace('<bullet_list bullet="-">', "<bullet_list>")
     file_regression.check(
         pformat,
         basename=f"snippet_post_{path.name[:-len(path.suffix)]}",

tests/test_snippets/snippet_post_icon-material-design.xml

@@ -2,7 +2,7 @@
     <section ids="heading" names="heading">
         <title>
             Heading
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     A regular icon: 

tests/test_snippets/snippet_pre_icon-material-design.xml

@@ -2,7 +2,7 @@
     <section ids="heading" names="heading">
         <title>
             Heading
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     A regular icon: 

tox.ini

@@ -70,3 +70,7 @@ commands =
         --re-ignore docs/_build/.* \
         --port 0 --open-browser \
          -n -b {posargs:html} docs/ docs/_build/{posargs:html}
+
+[flake8]
+max-line-length = 100
+extend-ignore = E203