Browse Source

chore: drop Python 2, require Python 3.6+ (#91)

* chore: drop Python 2 support, require 3.6+

* style: run pre-commit
master
Henry Schreiner 4 years ago committed by GitHub
parent
commit
5a19e3e21a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 1
      .appveyor.yml
  2. 18
      .github/workflows/pip.yml
  3. 53
      .github/workflows/wheels.yml
  4. 66
      .pre-commit-config.yaml
  5. 33
      README.md
  6. 66
      docs/conf.py
  7. 1
      docs/index.rst
  8. 6
      pyproject.toml
  9. 8
      setup.py

1
.appveyor.yml

@ -9,7 +9,6 @@ environment:
PYTHONWARNINGS: ignore:DEPRECATION PYTHONWARNINGS: ignore:DEPRECATION
MSSdk: 1 MSSdk: 1
matrix: matrix:
- PYTHON: 27
- PYTHON: 36 - PYTHON: 36
install: install:
- cmd: '"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" %PLATFORM%' - cmd: '"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" %PLATFORM%'

18
.github/workflows/pip.yml

@ -13,7 +13,7 @@ jobs:
fail-fast: false fail-fast: false
matrix: matrix:
platform: [windows-latest, macos-latest, ubuntu-latest] platform: [windows-latest, macos-latest, ubuntu-latest]
python-version: ["2.7", "3.5", "3.8", "3.9"] python-version: ["3.6", "3.10"]
runs-on: ${{ matrix.platform }} runs-on: ${{ matrix.platform }}
@ -27,22 +27,6 @@ jobs:
- name: Add requirements - name: Add requirements
run: python -m pip install --upgrade wheel setuptools run: python -m pip install --upgrade wheel setuptools
# Eventually Microsoft might have an action for setting up
# MSVC, but for now, this action works:
- name: Prepare compiler environment for Windows 🐍 2.7
if: matrix.python-version == 2.7 && runner.os == 'Windows'
uses: ilammy/msvc-dev-cmd@v1
with:
arch: x64
# This makes two environment variables available in the following step(s)
- name: Set Windows 🐍 2.7 environment variables
if: matrix.python-version == 2.7 && runner.os == 'Windows'
shell: bash
run: |
echo "DISTUTILS_USE_SDK=1" >> $GITHUB_ENV
echo "MSSdk=1" >> $GITHUB_ENV
- name: Build and install - name: Build and install
run: pip install --verbose . run: pip install --verbose .

53
.github/workflows/wheels.yml

@ -10,12 +10,6 @@ on:
types: types:
- published - published
env:
CIBW_TEST_COMMAND: python {project}/tests/test.py
CIBW_ARCHS_MACOS: auto universal2
CIBW_TEST_SKIP: "*universal2:arm64"
jobs: jobs:
build_sdist: build_sdist:
name: Build SDist name: Build SDist
@ -45,11 +39,9 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: pypa/cibuildwheel@v1.12.0 - uses: pypa/cibuildwheel@v2.2.0
env: env:
# Python 2.7 on Windows requires a workaround for C++11 support, CIBW_ARCHS_MACOS: auto universal2
# built separately below
CIBW_SKIP: cp27-win*
- name: Verify clean directory - name: Verify clean directory
run: git diff --exit-code run: git diff --exit-code
@ -61,48 +53,9 @@ jobs:
path: wheelhouse/*.whl path: wheelhouse/*.whl
# Windows 2.7 (requires workaround for MSVC 2008 replacement)
build_win27_wheels:
name: Py 2.7 wheels on Windows
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
with:
submodules: true
- uses: ilammy/msvc-dev-cmd@v1
- name: Build 64-bit wheel
uses: pypa/cibuildwheel@v1.12.0
env:
CIBW_BUILD: cp27-win_amd64
DISTUTILS_USE_SDK: 1
MSSdk: 1
- uses: ilammy/msvc-dev-cmd@v1
with:
arch: x86
- name: Build 32-bit wheel
uses: pypa/cibuildwheel@v1.12.0
env:
CIBW_BUILD: cp27-win32
DISTUTILS_USE_SDK: 1
MSSdk: 1
- name: Verify clean directory
run: git diff --exit-code
shell: bash
- uses: actions/upload-artifact@v2
with:
path: wheelhouse/*.whl
upload_all: upload_all:
name: Upload if release name: Upload if release
needs: [build_wheels, build_win27_wheels, build_sdist] needs: [build_wheels, build_sdist]
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: github.event_name == 'release' && github.event.action == 'published' if: github.event_name == 'release' && github.event.action == 'published'

66
.pre-commit-config.yaml

@ -0,0 +1,66 @@
# To use:
#
# pre-commit run -a
#
# Or:
#
# pre-commit install # (runs every time you commit in git)
#
# To update this file:
#
# pre-commit autoupdate
#
# See https://github.com/pre-commit/pre-commit
ci:
autoupdate_commit_msg: "chore: update pre-commit hooks"
autofix_commit_msg: "style: pre-commit fixes"
repos:
# Standard hooks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
hooks:
- id: check-added-large-files
- id: check-case-conflict
- id: check-merge-conflict
- id: check-symlinks
- id: check-yaml
exclude: ^conda\.recipe/meta\.yaml$
- id: debug-statements
- id: end-of-file-fixer
- id: mixed-line-ending
- id: requirements-txt-fixer
- id: trailing-whitespace
# Black, the code formatter, natively supports pre-commit
- repo: https://github.com/psf/black
rev: 21.9b0
hooks:
- id: black
files: ^(docs)
# Sort your imports in a standard form
- repo: https://github.com/PyCQA/isort
rev: 5.9.3
hooks:
- id: isort
# Upgrade older Python syntax
- repo: https://github.com/asottile/pyupgrade
rev: v2.29.0
hooks:
- id: pyupgrade
args: ["--py36-plus"]
# Changes tabs to spaces
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.1.10
hooks:
- id: remove-tabs
# Suggested hook if you add a .clang-format file
# - repo: https://github.com/pre-commit/mirrors-clang-format
# rev: v13.0.0
# hooks:
# - id: clang-format

33
README.md

@ -27,36 +27,15 @@ python_example
[appveyor-badge]: https://travis-ci.org/pybind/python_example.svg?branch=master&status=passed [appveyor-badge]: https://travis-ci.org/pybind/python_example.svg?branch=master&status=passed
An example project built with [pybind11](https://github.com/pybind/pybind11). An example project built with [pybind11](https://github.com/pybind/pybind11).
This requires Python 3.6+; for older versions of Python, check the commit
history.
Installation Installation
------------ ------------
**On Unix (Linux, OS X)**
- clone this repository
- `pip install ./python_example`
**On Windows (Requires Visual Studio 2015)**
- For Python 3.5+:
- clone this repository
- `pip install ./python_example`
- For Python 2.7:
Pybind11 requires a C++11 compliant compiler (i.e. Visual Studio 2015 on
Windows). Running a regular `pip install` command will detect the version
of the compiler used to build Python and attempt to build the extension
with it. We must force the use of Visual Studio 2015.
- clone this repository - clone this repository
- `"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" x64`
- `set DISTUTILS_USE_SDK=1`
- `set MSSdk=1`
- `pip install ./python_example` - `pip install ./python_example`
Note that this requires the user building `python_example` to have registry edition
rights on the machine, to be able to run the `vcvarsall.bat` script.
CI Examples CI Examples
----------- -----------
@ -65,14 +44,6 @@ binary "wheels" for all platforms is illustrated in the "wheels.yml" file,
using [`cibuildwheel`][]. You can also see a basic recipe for building and using [`cibuildwheel`][]. You can also see a basic recipe for building and
testing in `pip.yml`, and `conda.yml` has an example of a conda recipe build. testing in `pip.yml`, and `conda.yml` has an example of a conda recipe build.
Windows Python 2.7 runtime requirements
----------------------------
On Windows, the Visual C++ 2015 redistributable packages are a runtime
requirement for this project if you build for Python 2.7 (newer versions of
Python include this redistributable). It can be found
[here](https://www.microsoft.com/en-us/download/details.aspx?id=48145).
Building the documentation Building the documentation
-------------------------- --------------------------

66
docs/conf.py

@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
# #
# python_example documentation build configuration file, created by # python_example documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 26 00:29:33 2016. # sphinx-quickstart on Fri Feb 26 00:29:33 2016.
@ -12,8 +11,8 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys
import os import os
import sys
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@ -29,41 +28,41 @@ import os
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinx.ext.intersphinx', "sphinx.ext.intersphinx",
'sphinx.ext.autosummary', "sphinx.ext.autosummary",
'sphinx.ext.napoleon', "sphinx.ext.napoleon",
] ]
autosummary_generate = True autosummary_generate = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ["_templates"]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = '.rst' source_suffix = ".rst"
# The encoding of source files. # The encoding of source files.
# source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # General information about the project.
project = u'python_example' project = "python_example"
copyright = u'2016, Sylvain Corlay' copyright = "2016, Sylvain Corlay"
author = u'Sylvain Corlay' author = "Sylvain Corlay"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = u'0.0.1' version = "0.0.1"
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = u'0.0.1' release = "0.0.1"
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -80,7 +79,7 @@ language = None
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['_build'] exclude_patterns = ["_build"]
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
@ -98,7 +97,7 @@ exclude_patterns = ['_build']
# show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []
@ -114,7 +113,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'alabaster' html_theme = "alabaster"
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@ -143,7 +142,7 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ["_static"]
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
@ -206,20 +205,17 @@ html_static_path = ['_static']
# html_search_scorer = 'scorer.js' # html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'python_exampledoc' htmlhelp_basename = "python_exampledoc"
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper', #'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt', #'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #'preamble': '',
# Latex figure (float) alignment # Latex figure (float) alignment
#'figure_align': 'htbp', #'figure_align': 'htbp',
} }
@ -228,8 +224,13 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'python_example.tex', u'python_example Documentation', (
u'Sylvain Corlay', 'manual'), master_doc,
"python_example.tex",
"python_example Documentation",
"Sylvain Corlay",
"manual",
),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -258,8 +259,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'python_example', u'python_example Documentation', (master_doc, "python_example", "python_example Documentation", [author], 1)
[author], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@ -272,9 +272,15 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'python_example', u'python_example Documentation', (
author, 'python_example', 'One line description of project.', master_doc,
'Miscellaneous'), "python_example",
"python_example Documentation",
author,
"python_example",
"One line description of project.",
"Miscellaneous",
),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
@ -291,4 +297,4 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None} intersphinx_mapping = {"https://docs.python.org/": None}

1
docs/index.rst

@ -7,4 +7,3 @@ Contents:
:maxdepth: 2 :maxdepth: 2
python_example python_example

6
pyproject.toml

@ -2,7 +2,11 @@
requires = [ requires = [
"setuptools>=42", "setuptools>=42",
"wheel", "wheel",
"pybind11>=2.7.0", "pybind11>=2.8.0",
] ]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"
[tool.cibuildwheel]
test-command = "python {project}/tests/test.py"
test-skip = "*universal2:arm64"

8
setup.py

@ -1,10 +1,9 @@
from setuptools import setup import sys
from pybind11 import get_cmake_dir
# Available at setup time due to pyproject.toml # Available at setup time due to pyproject.toml
from pybind11.setup_helpers import Pybind11Extension, build_ext from pybind11.setup_helpers import Pybind11Extension, build_ext
from pybind11 import get_cmake_dir from setuptools import setup
import sys
__version__ = "0.0.1" __version__ = "0.0.1"
@ -39,4 +38,5 @@ setup(
# level" feature, but in the future it may provide more features. # level" feature, but in the future it may provide more features.
cmdclass={"build_ext": build_ext}, cmdclass={"build_ext": build_ext},
zip_safe=False, zip_safe=False,
python_requires=">=3.6",
) )

Loading…
Cancel
Save