Merge pull request #972 from makermelissa/main

Convert Blinka to use pyproject.toml

Author: makermelissa

.github/workflows/build.yml

@@ -16,10 +16,10 @@ jobs:
     - name: Translate Repo Name For Build Tools filename_prefix
       id: repo-name
       run: echo "repo-name=Adafruit-Blinka" >> $GITHUB_OUTPUT
-    - name: Set up Python 3.8
+    - name: Set up Python 3.11
       uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: 3.11
     - name: Versions
       run: |
         python3 --version
@@ -47,7 +47,12 @@ jobs:
     - name: Build docs
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html
+    - name: Check For pyproject.toml
+      id: need-pypi
+      run: |
+        echo "pyproject-toml=$( find . -wholename './pyproject.toml' )" >> $GITHUB_OUTPUT
     - name: Build Python package
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       run: |
         pip install --upgrade build twine
         for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do

.github/workflows/release.yml

@@ -12,22 +12,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - name: Check For setup.py
+    - name: Check For pyproject.toml
       id: need-pypi
       run: |
-        echo "setup-py=$( find . -wholename './setup.py' )" >> $GITHUB_OUTPUT
+        echo "pyproject-toml=$( find . -wholename './pyproject.toml' )" >> $GITHUB_OUTPUT
     - name: Set up Python
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       uses: actions/setup-python@v4
       with:
-        python-version: '3.x'
+        python-version: '3.11'
     - name: Install dependencies
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       run: |
         python -m pip install --upgrade pip
         pip install --upgrade build twine
     - name: Build and publish
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       env:
         TWINE_USERNAME: ${{ secrets.pypi_username }}
         TWINE_PASSWORD: ${{ secrets.pypi_password }}

docs/conf.py

@@ -97,25 +97,21 @@
 #
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    try:
-        import sphinx_rtd_theme
-
-        html_theme = "sphinx_rtd_theme"
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
-    except:
-        html_theme = "default"
-        html_theme_path = ["."]
-else:
-    html_theme_path = ["."]
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = "_static/favicon.ico"
+
 # Output file base name for HTML help builder.
-htmlhelp_basename = "AdafruitBlinkaLibrarydoc"
+htmlhelp_basename = "Adafruit_blinkaDisplayioLibrarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 

pyproject.toml

@@ -0,0 +1,59 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "setuptools-scm",
+]
+
+[project]
+name = "Adafruit-Blinka"
+description = "CircuitPython APIs for non-CircuitPython versions of Python such as CPython on Linux and MicroPython."
+version = "0.0.0+auto.0"
+readme = "README.rst"
+authors = [
+    {name = "Adafruit Industries", email = "[email protected]"}
+]
+urls = {Homepage = "https://github.com/adafruit/Adafruit_Blinka"}
+license = {text = "MIT"}
+classifiers=[
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: System :: Hardware",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+]
+dynamic = ["dependencies"]
+
+[tool.setuptools]
+py-modules = [
+    "analogio",
+    "bitbangio",
+    "board",
+    "busio",
+    "digitalio",
+    "keypad",
+    "micropython",
+    "neopixel_write",
+    "onewireio",
+    "pulseio",
+    "pwmio",
+    "rainbowio",
+    "usb_hid",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = [
+    "adafruit_blinka.microcontroller.bcm283x.libgpiod_pulsein*",
+    "adafruit_blinka.microcontroller.amlogic.meson_g12_common.pulseio.libgpiod_pulsein*",
+    "*.pyi"
+]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}

requirements.txt

@@ -1,9 +1,12 @@
- # requirements.txt
- #
- # installs dependencies from ./setup.py, and the package itself,
- # in editable mode
- # -e .
-
- # (the -e above is optional). you could also just install the package
- # normally with just the line below (after uncommenting)
- .
+Adafruit-PlatformDetect>=3.70.1
+Adafruit-PureIO>=1.1.7
+Jetson.GPIO; platform_machine=='aarch64'
+RPi.GPIO; platform_machine=='armv7l' or platform_machine=='armv6l' or platform_machine=='aarch64'
+rpi_ws281x>=4.0.0; platform_machine=='armv7l' or platform_machine=='armv6l' or platform_machine=='aarch64'
+sysv_ipc>=1.1.0; sys_platform == 'linux' and platform_machine!='mips'
+pyftdi>=0.40.0
+binho-host-adapter>=0.1.6
+adafruit-circuitpython-typing
+toml>=0.10.2; python_version<'3.11'
+lgpio>=0.2.2.0
+Adafruit-Blinka-Raspberry-Pi5-Neopixel; platform_machine=='aarch64'