Merge pull request #195 from tekktrik/dev/use-pyproject-toml

Update for pyproject.toml migration

Author: ladyada

.gitignore

@@ -21,6 +21,7 @@ _build
 
 # Virtual environment-specific files
 .env
+.venv
 
 # MacOS-specific files
 *.DS_Store

{{ cookiecutter.__dirname }}/.github/workflows/build.yml

@@ -67,14 +67,16 @@ jobs:
       if: contains(steps.need-docs.outputs.docs, 'docs')
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html
-    - name: Check For setup.py
+    - name: Check For pyproject.toml
       id: need-pypi
       run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
     - name: Build Python package
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       run: |
-        pip install --upgrade setuptools wheel twine readme_renderer testresources
-        python setup.py sdist
-        python setup.py bdist_wheel --universal
+        pip install --upgrade build twine
+        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
+            sed -i -e "s/0.0.0+auto.0/1.2.3/" $file;
+        done;
+        python -m build
         twine check dist/*

{{ cookiecutter.__dirname }}/.github/workflows/release.yml

@@ -61,28 +61,28 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: Check For setup.py
+    - name: Check For pyproject.toml
       id: need-pypi
       run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
     - 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@v2
       with:
         python-version: '3.x'
     - 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 setuptools wheel twine
+        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: {% raw %}${{ secrets.pypi_username }}{% endraw %}
         TWINE_PASSWORD: {% raw %}${{ secrets.pypi_password }}{% endraw %}
       run: |
-        for file in $(find -not -path "./.*" -not -path "./docs*" -name "*.py"); do
-            {% raw %}sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file;{% endraw %}
+        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
+            {% raw %}sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file;{% endraw %}
         done;
-        python setup.py sdist
+        python -m build
         twine upload dist/*

{{ cookiecutter.__dirname }}/optional_requirements.txt

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense

{{ cookiecutter.__dirname }}/{% if cookiecutter.pypi_release in ['n', 'no'] %}pyproject.toml.disabled{% endif %}

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2021 Foamyguy for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+#
+# This library is not deployed to PyPI. It is either a board-specific helper library, or
+# does not make sense for use on or is incompatible with single board computers and Linux.
+#

{{ cookiecutter.__dirname }}/{% if cookiecutter.pypi_release in ['n', 'no'] %}setup.py.disabled{% endif %}

@@ -0,0 +1,66 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) {% now 'utc', '%Y' %} {{ cookiecutter.author_name }}{% if cookiecutter.company %} for {{ cookiecutter.company }}{% endif %}
+#
+# SPDX-License-Identifier: MIT
+
+{# put keywords into an iterable list, based on word wrapping #}
+{%- set kw_list = namespace(kw_list=[], default=["adafruit", "blinka", "circuitpython", "micropython"]) -%}
+{%- do kw_list.default.append(cookiecutter.library_name|lower|replace(" ", "-")) -%}
+{%- do kw_list.default.extend(cookiecutter.library_keywords.split(" ")) -%}
+{%- set wrapped = kw_list.default|unique|join(" ")|wordwrap(break_long_words=False) -%}
+{%- do kw_list.kw_list.extend(wrapped.split("\n")) -%}
+{# create repo and pypi names #}
+{%- if cookiecutter.target_bundle != 'CircuitPython Org' -%}
+    {%- if cookiecutter.library_prefix -%}
+        {%- set repo_name = (cookiecutter.library_prefix | capitalize) -%}
+        {%- set repo_name = repo_name + '_CircuitPython_' -%}
+        {%- set repo_name = repo_name + cookiecutter.library_name | replace(" ", "_") -%}
+    {%- else -%}
+        {%- set repo_name = 'CircuitPython_' -%}
+        {%- set repo_name = repo_name + cookiecutter.library_name | replace(" ", "_") -%}
+    {%- endif -%}
+{%- else -%}
+    {%- set repo_name = 'CircuitPython_Org_' + cookiecutter.library_name | replace(" ", "_") -%}
+{%- endif -%}
+{%- set pypi_name = repo_name|lower|replace("_", "-")|replace(" ", "-")|replace("circuitpython-org-", "circuitpython-") -%}
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "setuptools-scm",
+]
+
+[project]
+name = "{{ pypi_name }}"
+description = "{{ cookiecutter.library_description }}"
+version = "0.0.0+auto.0"
+readme = "README.rst"
+authors = [
+    {name = "Adafruit Industries", email = "[email protected]"}
+]
+urls = {Homepage = "https://github.com/{{ cookiecutter.github_user }}/{{ repo_name }}"}
+keywords = [
+{% for kw_list_keyword in kw_list.default %}    "{{ kw_list_keyword }}",
+{% endfor -%}
+]
+license = {text = "MIT"}
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Hardware",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dynamic = ["dependencies", "optional-dependencies"]
+
+[tool.setuptools]
+# You can just specify the packages manually here if your project is
+# simple. Or you can use find_packages().
+# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
+#       CHANGE `py_modules = ['...']` TO `packages = ['...']`
+py-modules = ["{% if cookiecutter.library_prefix %}{{ cookiecutter.library_prefix | lower | replace(" ", "_") }}_{% endif %}{{ cookiecutter.library_name | lower | replace(" ", "_") }}"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies = {optional = {file = ["optional_requirements.txt"]}}

{{ cookiecutter.__dirname }}/{% if cookiecutter.pypi_release in ['y', 'yes'] %}pyproject.toml{% endif %}

@@ -49,5 +49,5 @@
     {%- set repo_name = 'CircuitPython_Org_' + cookiecutter.library_name | replace(" ", "_") -%}
 {% endif -%}
 
-__version__ = "0.0.0-auto.0"
+__version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/{{ cookiecutter.github_user }}/{{ repo_name }}.git"