Rename `DiverseSelector` to `selector`

.github/CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
 # Contributor Covenant Code of Conduct
 
-It is recommended to follow the code of conduct as described in 
+It is recommended to follow the code of conduct as described in
 https://qcdevs.org/guidelines/QCDevsCodeOfConduct/.

.pre-commit-config.yaml

@@ -42,15 +42,16 @@ repos:
     # sorts entries in requirements.txt
     -   id: requirements-txt-fixer
 
-# https://github.com/asottile/setup-cfg-fmt
--   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.5.0
-    hooks:
-    -   id: setup-cfg-fmt
+# we are not using this for now as we decided to use pyproject.toml instead
+## https://github.com/asottile/setup-cfg-fmt
+#-   repo: https://github.com/asottile/setup-cfg-fmt
+#    rev: v2.5.0
+#    hooks:
+#    -   id: setup-cfg-fmt
 
 # -   repo: https://github.com/psf/black-pre-commit-mirror
 -   repo: https://github.com/psf/black
-    rev: 23.10.0
+    rev: 23.10.1
     hooks:
     -    id: black
          args: [
@@ -90,8 +91,10 @@ repos:
               ^docs/
               ^doc/
           )
-        args: ["-c", "pyproject.toml"]
-        additional_dependencies: ["bandit[toml]"]
+        args: [
+               "-c", "pyproject.toml"
+              ]
+        additional_dependencies: [ "bandit[toml]" ]
 
 -   repo: https://github.com/asottile/pyupgrade
     rev: v3.15.0

devtools/README.md

@@ -1,63 +0,0 @@
-# Development, testing, and deployment tools
-
-This directory contains a collection of tools for running Continuous Integration (CI) tests, 
-conda installation, and other development tools not directly related to the coding process.
-
-
-## Manifest
-
-### Continuous Integration
-
-You should test your code, but do not feel compelled to use these specific programs. You also may not need Unix and 
-Windows testing if you only plan to deploy on specific platforms. These are just to help you get started.
-
-The items in this directory have been left for legacy purposes since the change to GitHub Actions, 
-They will likely be removed in a future version.
-
-* `legacy-miniconda-setup`: A preserved copy of a helper directory which made Linux and OSX based testing through [Travis-CI](https://about.travis-ci.com/) simpler
-  * `before_install.sh`: Pip/Miniconda pre-package installation script for Travis. No longer needed thanks to 
-    [GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions) and the [conda-incubator/setup-miniconda Action](https://github.com/conda-incubator/setup-miniconda)
-
-### Conda Environment:
-
-This directory contains the files to setup the Conda environment for testing purposes
-
-* `conda-envs`: directory containing the YAML file(s) which fully describe Conda Environments, their dependencies, and those dependency provenance's
-  * `test_env.yaml`: Simple test environment file with base dependencies. Channels are not specified here and therefore respect global Conda configuration
-  
-### Additional Scripts:
-
-This directory contains OS agnostic helper scripts which don't fall in any of the previous categories
-* `scripts`
-  * `create_conda_env.py`: Helper program for spinning up new conda environments based on a starter file with Python Version and Env. Name command-line options
-
-
-## How to contribute changes
-- Clone the repository if you have write access to the main repo, fork the repository if you are a collaborator.
-- Make a new branch with `git checkout -b {your branch name}`
-- Make changes and test your code
-- Ensure that the test environment dependencies (`conda-envs`) line up with the build and deploy dependencies (`conda-recipe/meta.yaml`)
-- Push the branch to the repo (either the main or your fork) with `git push -u origin {your branch name}`
-  * Note that `origin` is the default name assigned to the remote, yours may be different
-- Make a PR on GitHub with your changes
-- We'll review the changes and get your code into the repo after lively discussion!
-
-
-## Checklist for updates
-- [ ] Make sure there is an/are issue(s) opened for your specific update
-- [ ] Create the PR, referencing the issue
-- [ ] Debug the PR as needed until tests pass
-- [ ] Tag the final, debugged version 
-   *  `git tag -a X.Y.Z [latest pushed commit] && git push --follow-tags`
-- [ ] Get the PR merged in
-
-## Versioneer Auto-version
-[Versioneer](https://github.com/warner/python-versioneer) will automatically infer what version 
-is installed by looking at the `git` tags and how many commits ahead this version is. The format follows 
-[PEP 440](https://www.python.org/dev/peps/pep-0440/) and has the regular expression of:
-```regexp
-\d+.\d+.\d+(?\+\d+-[a-z0-9]+)
-```
-If the version of this commit is the same as a `git` tag, the installed version is the same as the tag, 
-e.g. `DiverseSelector-0.1.2`, otherwise it will be appended with `+X` where `X` is the number of commits 
-ahead from the last tag, and then `-YYYYYY` where the `Y`'s are replaced with the `git` commit hash.

devtools/conda-envs/test_env.yaml

@@ -1,18 +0,0 @@
-name: test
-channels:
-
-  - defaults
-dependencies:
-    # Base depends
-  - python
-  - pip
-
-    # Testing
-  - pytest
-  - pytest-cov
-  - codecov
-
-    # Pip-only installs
-  #- pip:
-  #  - codecov
-

devtools/legacy-miniconda-setup/before_install.sh

@@ -1,21 +0,0 @@
-# Temporarily change directory to $HOME to install software
-pushd .
-cd $HOME
-# Make sure some level of pip is installed
-python -m ensurepip
-
-if [ "$TRAVIS_OS_NAME" == "osx" ]; then
-    HOMEBREW_NO_AUTO_UPDATE=1 brew upgrade pyenv
-    # Pyenv requires minor revision, get the latest
-    PYENV_VERSION=$(pyenv install --list |grep $PYTHON_VER | sed -n "s/^[ \t]*\(${PYTHON_VER}\.*[0-9]*\).*/\1/p" | tail -n 1)
-    # Install version
-    pyenv install -f $PYENV_VERSION
-    # Use version for this
-    pyenv global $PYENV_VERSION
-    # Setup up path shims
-    eval "$(pyenv init -)"
-fi
-pip install --upgrade pip setuptools
-
-# Restore original directory
-popd

devtools/scripts/create_conda_env.py

@@ -1,95 +0,0 @@
-import argparse
-import os
-import re
-import glob
-import shutil
-import subprocess as sp
-from tempfile import TemporaryDirectory
-from contextlib import contextmanager
-# YAML imports
-try:
-    import yaml  # PyYAML
-    loader = yaml.load
-except ImportError:
-    try:
-        import ruamel_yaml as yaml  # Ruamel YAML
-    except ImportError:
-        try:
-            # Load Ruamel YAML from the base conda environment
-            from importlib import util as import_util
-            CONDA_BIN = os.path.dirname(os.environ['CONDA_EXE'])
-            ruamel_yaml_path = glob.glob(os.path.join(CONDA_BIN, '..',
-                                                      'lib', 'python*.*', 'site-packages',
-                                                      'ruamel_yaml', '__init__.py'))[0]
-            # Based on importlib example, but only needs to load_module since its the whole package, not just
-            # a module
-            spec = import_util.spec_from_file_location('ruamel_yaml', ruamel_yaml_path)
-            yaml = spec.loader.load_module()
-        except (KeyError, ImportError, IndexError):
-            raise ImportError("No YAML parser could be found in this or the conda environment. "
-                              "Could not find PyYAML or Ruamel YAML in the current environment, "
-                              "AND could not find Ruamel YAML in the base conda environment through CONDA_EXE path. " 
-                              "Environment not created!")
-    loader = yaml.YAML(typ="safe").load  # typ="safe" avoids odd typing on output
-
-
-@contextmanager
-def temp_cd():
-    """Temporary CD Helper"""
-    cwd = os.getcwd()
-    with TemporaryDirectory() as td:
-        try:
-            os.chdir(td)
-            yield
-        finally:
-            os.chdir(cwd)
-
-
-# Args
-parser = argparse.ArgumentParser(description='Creates a conda environment from file for a given Python version.')
-parser.add_argument('-n', '--name', type=str,
-                    help='The name of the created Python environment')
-parser.add_argument('-p', '--python', type=str,
-                    help='The version of the created Python environment')
-parser.add_argument('conda_file',
-                    help='The file for the created Python environment')
-
-args = parser.parse_args()
-
-# Open the base file
-with open(args.conda_file, "r") as handle:
-    yaml_script = loader(handle.read())
-
-python_replacement_string = "python {}*".format(args.python)
-
-try:
-    for dep_index, dep_value in enumerate(yaml_script['dependencies']):
-        if re.match('python([ ><=*]+[0-9.*]*)?$', dep_value):  # Match explicitly 'python' and its formats
-            yaml_script['dependencies'].pop(dep_index)
-            break  # Making the assumption there is only one Python entry, also avoids need to enumerate in reverse
-except (KeyError, TypeError):
-    # Case of no dependencies key, or dependencies: None
-    yaml_script['dependencies'] = []
-finally:
-    # Ensure the python version is added in. Even if the code does not need it, we assume the env does
-    yaml_script['dependencies'].insert(0, python_replacement_string)
-
-# Figure out conda path
-if "CONDA_EXE" in os.environ:
-    conda_path = os.environ["CONDA_EXE"]
-else:
-    conda_path = shutil.which("conda")
-if conda_path is None:
-    raise RuntimeError("Could not find a conda binary in CONDA_EXE variable or in executable search path")
-
-print("CONDA ENV NAME  {}".format(args.name))
-print("PYTHON VERSION  {}".format(args.python))
-print("CONDA FILE NAME {}".format(args.conda_file))
-print("CONDA PATH      {}".format(conda_path))
-
-# Write to a temp directory which will always be cleaned up
-with temp_cd():
-    temp_file_name = "temp_script.yaml"
-    with open(temp_file_name, 'w') as f:
-        f.write(yaml.dump(yaml_script))
-    sp.call("{} env create -n {} -f {}".format(conda_path, args.name, temp_file_name), shell=True)

pyproject.toml

@@ -0,0 +1,380 @@
+# [build-system]
+# build-backend = "setuptools.build_meta"
+# requires = ["setuptools>=61.0", "wheel>=0.37.1"]
+# This example pyproject.toml is for a basic pip+setuptools setup.
+# If you use a project management tool (like Poetry), then
+# those tools will have slightly different configurations or additions.
+
+# I highly recommend using a project management tool for your project.
+# Project management is a highly opinionated subject.
+# There are a lot of good, robust tools in this space now (as of 2023)
+# Two that I've used and recommend are Poetry and PDM.
+# Poetry is more mature, PDM is recent, both work well.
+# - Poetry: https://python-poetry.org/
+# - PDM: https://pdm.fming.dev/latest/
+
+# https://gist.githubusercontent.com/GhostofGoes/75051c4aeb215bc3cf48c10f5454b399/raw/499661609846ab52b8fc7e6acf0562275ca22517/pyproject.toml
+# Resources
+#
+# - https://packaging.python.org/en/latest/tutorials/packaging-projects/
+# - https://betterprogramming.pub/a-pyproject-toml-developers-cheat-sheet-5782801fb3ed
+#
+# Examples of pyproject.toml files from open-source projects:
+# - https://github.com/carlosperate/awesome-pyproject
+# - https://github.com/SpikeInterface/spikeinterface/blob/master/pyproject.toml
+# - https://github.com/codespell-project/codespell/blob/master/pyproject.toml
+# - https://github.com/hynek/structlog/blob/main/pyproject.toml
+
+
+[project]
+# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
+name = "acme"
+version = "0.0.1"
+description = "ACME tool"
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+# "LICENSE" is name of the license file, which must be in root of project folder
+license = {file = "LICENSE"}
+authors = [
+    {name = "Joe Example", email = "[email protected]"},
+]
+keywords = ["keyword", "are", "cool"]
+
+# https://pypi.org/classifiers/
+# Add PyPI classifiers here
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: Implementation :: CPython",
+]
+
+# Required dependencies for install/usage of your package or application
+# If you don't have any dependencies, leave this section empty
+# Format for dependency strings: https://peps.python.org/pep-0508/
+dependencies = [
+    # ... put stuff here ...
+]
+
+[project.scripts]
+# Command line interface entrypoint scripts
+acme = "acme.__main__:main"
+
+[project.urls]
+# Use PyPI-standard names here
+# Homepage
+# Documentation
+# Changelog
+# Issue Tracker
+# Source
+# Discord server
+"Homepage" = "<url>"
+"Documentation" = "<url>"
+
+# Development dependencies
+# pip install -e .[lint,test,exe]
+# pip install -e .[dev]
+[project.optional-dependencies]
+lint = [
+    # checks for spelling mistakes
+    "codespell>=2.2.4",
+
+    # ruff linter checks for issues and potential bugs
+    "ruff",
+
+    # checks for unused code
+    "vulture",
+
+    # required for codespell to parse pyproject.toml
+    "tomli",
+
+    # validation of pyproject.toml
+    "validate-pyproject[all]",
+
+    # automatic sorting of imports
+    "isort",
+
+    # automatic code formatting to follow a consistent style
+    "black",
+]
+
+test = [
+    # Handles most of the testing work, including execution
+    # Docs: https://docs.pytest.org/en/stable/contents.html
+    "pytest",
+
+    # "Coverage" is how much of the code is actually run (it's "coverage")
+    # Generates coverage reports from test suite runs
+    "pytest-cov",
+    "tomli",
+
+    # pytest wrapper around the "mock" library
+    "pytest-mock",
+
+    # Randomizes the order of test execution
+    "pytest-randomly",
+
+    # Required for comparing device data exports and a few other complex structures
+    # Docs: https://zepworks.com/deepdiff/current/
+    "deepdiff",
+
+    # Test parallelization, as well as remote execution (which we may do someday)
+    "pytest-xdist[psutil]",
+
+    # Detailed pytest results saved to a JSON file
+    "pytest-json-report",
+
+    # Better parsing of doctests
+    "xdoctest",
+
+    # Mocking of HTTP responses for the "requests" module
+    "requests-mock",
+
+    # Colors for doctest output
+    "Pygments",
+]
+
+exe = [
+    "setuptools",
+    "wheel",
+    "build",
+    "tomli",
+    "pyinstaller",
+    "staticx;platform_system=='Linux'",
+]
+
+dev = [
+    # https://hynek.me/articles/python-recursive-optional-dependencies/
+    "acme[lint,test,exe]",
+
+    # Useful for building quick scripts for testing purposes
+    # https://github.com/google/python-fire
+    "fire",
+
+    # Code quality tools
+    "mypy",
+
+    # Improved exception traceback output
+    # https://github.com/qix-/better-exceptions
+    "better_exceptions",
+
+    # Analyzing dependencies
+    # install graphviz to generate graphs
+    "graphviz",
+    "pipdeptree",
+]
+
+
+[tool.setuptools]
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+platforms = ["Linux", "Windows"]
+include-package-data = true
+zip-safe = true  # This just means it's safe to zip up the bdist
+
+# Non-code data that should be included in the package source code
+# https://setuptools.pypa.io/en/latest/userguide/datafiles.html
+[tool.setuptools.package-data]
+acme = ["*.xml"]
+
+# Python modules and packages that are included in the
+# distribution package (and therefore become importable)
+[tool.setuptools.packages.find]
+exclude = ["tests", "tests.*", "examples"]
+
+
+
+# PDM example
+[tool.pdm.scripts]
+isort = "isort acme"
+black = "black acme"
+format = {composite = ["isort", "black"]}
+check_isort = "isort --check acme tests"
+check_black = "black --check acme tests"
+vulture = "vulture --min-confidence 100 acme tests"
+ruff = "ruff check acme tests"
+fix = "ruff check --fix acme tests"
+codespell = "codespell --toml ./pyproject.toml"
+lint = {composite = ["vulture", "codespell", "ruff", "check_isort", "check_black"]}
+
+
+
+[tool.codespell]
+# codespell supports pyproject.toml since version 2.2.2
+# NOTE: the "tomli" package must be installed for this to work
+# https://github.com/codespell-project/codespell#using-a-config-file
+# NOTE: ignore words for codespell must be lowercase
+check-filenames = ""
+ignore-words-list = "word,another,something"
+skip = "htmlcov,.doctrees,*.pyc,*.class,*.ico,*.out,*.PNG,*.inv,*.png,*.jpg,*.dot"
+
+
+[tool.black]
+line-length = 88
+# If you need to exclude directories from being reformatted by black
+# force-exclude = '''
+# (
+#     somedirname
+#     | dirname
+#     | filename\.py
+# )
+# '''
+
+
+[tool.isort]
+profile = "black"
+known_first_party = ["acme"]
+# If you need to exclude files from having their imports sorted
+extend_skip_glob  = [
+    "acme/somefile.py",
+    "acme/somedir/*",
+]
+
+
+# https://beta.ruff.rs/docs
+[tool.ruff]
+line-length = 99
+show-source = true
+
+# Rules: https://beta.ruff.rs/docs/rules
+# If you violate a rule, lookup the rule on the Rules page in ruff docs.
+# Many rules have links you can click with a explanation of the rule and how to fix it.
+# If there isn't a link, go to the project the rule was source from (e.g. flake8-bugbear)
+# and review it's docs for the corresponding rule.
+# If you're still confused, ask a fellow developer for assistance.
+# You can also run "ruff rule <rule>" to explain a rule on the command line, without a browser or internet access.
+select = [
+    "E",    # pycodestyle
+    "F",    # Pyflakes
+    "W",    # Warning
+    "B",    # flake8-bugbear
+    "A",    # flake8-builtins
+    "C4",   # flake8-comprehensions
+    "T10",  # flake8-debugger
+    "EXE",  # flake8-executable,
+    "ISC",  # flake8-implicit-str-concat
+    "G",    # flake8-logging-format
+    "PIE",  # flake8-pie
+    "T20",  # flake8-print
+    "PT",   # flake8-pytest-style
+    "RSE",  # flake8-raise
+    "RET",  # flake8-return
+    "TID",  # flake8-tidy-imports
+    "ARG",  # flake8-unused-arguments
+    "PGH",  # pygrep-hooks
+    "PLC",  # Pylint Convention
+    "PLE",  # Pylint Errors
+    "PLW",  # Pylint Warnings
+    "RUF",  # Ruff-specific rules
+
+    # ** Things to potentially enable in the future **
+    # DTZ requires all usage of datetime module to have timezone-aware
+    # objects (so have a tz argument or be explicitly UTC).
+    # "DTZ",  # flake8-datetimez
+    # "PTH",  # flake8-use-pathlib
+    # "SIM",  # flake8-simplify
+]
+
+# Files to exclude from linting
+extend-exclude = [
+    "*.pyc",
+    "__pycache__",
+]
+
+# Linting error codes to ignore
+ignore = [
+    "F403",    # unable to detect undefined names from star imports
+    "F405",    # undefined locals from star imports
+    "W605",    # invalid escape sequence
+    "A003",    # shadowing python builtins
+    "RET505",  # unnecessary 'else' after 'return' statement
+    "RET504",  # Unnecessary variable assignment before return statement
+    "RET507",  # Unnecessary {branch} after continue statement
+    "PT011",   # pytest-raises-too-broad
+    "PT012",   # pytest.raises() block should contain a single simple statement
+    "PLW0603", # Using the global statement to update is discouraged
+    "PLW2901", # for loop variable overwritten by assignment target
+    "G004",    # Logging statement uses f-string
+    "PIE790",  # no-unnecessary-pass
+    "PIE810",  # multiple-starts-ends-with
+    "PGH003",  # Use specific rule codes when ignoring type issues
+    "PLC1901", # compare-to-empty-string
+]
+
+# Linting error codes to ignore on a per-file basis
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401", "E501"]
+"acme/somefile.py" = ["E402", "E501"]
+"acme/somedir/*" = ["E501"]
+
+
+# Configuration for mypy
+# https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file
+[tool.mypy]
+python_version = "3.9"
+follow_imports = "skip"
+ignore_missing_imports = true
+files = "acme"  # directory mypy should analyze
+# Directories to exclude from mypy's analysis
+exclude = [
+    "acme/somedir",
+    "acme/somefile\\.py",
+    "dirname",
+]
+
+
+# Configuration for pytest
+# https://docs.pytest.org/en/latest/reference/customize.html#pyproject-toml
+[tool.pytest.ini_options]
+testpaths = "tests"  # directory containing your tests
+norecursedirs = [
+    ".vscode",
+    "__pycache__"
+]
+# Warnings that should be ignored
+filterwarnings = [
+    "ignore::DeprecationWarning"
+]
+# custom markers that can be used using pytest.mark
+markers = [
+    "slow: lower-importance tests that take an excessive amount of time",
+]
+
+
+# Configuration for coverage.py
+[tool.coverage.run]
+# files or directories to exclude from coverage calculations
+omit = [
+    'acme/somedir/*',
+    'acme/somefile.py',
+]
+
+
+# Configuration for vulture
+[tool.vulture]
+# Files or directories to exclude from vulture
+# The syntax is a little funky
+exclude = [
+    "somedir",
+    "*somefile.py",
+]
+
+# configuration for bandit
+[tool.bandit]
+# skips some bandit tests
+skips=[
+    "B101", # Ignore defensive `assert`s, 80% of repos do this
+    "B311", # Standard pseudo-random generators are not suitable for security/cryptographic purposes
+    "B404", # Ignore warnings about importing subprocess
+    "B603", # Ignore warnings about calling subprocess
+    "B607", # Ignore warnings about calling subprocess
+]

setup.cfg

@@ -1,28 +0,0 @@
-[metadata]
-name = selector
-long_description = file: README.md
-long_description_content_type = text/markdown
-license = GPL-3.0
-license_files = LICENSE
-classifiers =
-    License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: Implementation :: CPython
-
-[options]
-python_requires = >=3.9
-
-[coverage:run]
-omit =
-    selector/methods/tests/*
-    */tests/*
-    */_version.py
-
-[yapf]
-COLUMN_LIMIT = 109
-INDENT_WIDTH = 4
-USE_TABS = False
-
-[aliases]
-test = pytest

setup.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # The Selector library provides a set of tools for selecting a
 # subset of the dataset and computing diversity.
 #
@@ -33,7 +32,7 @@ needs_pytest = {"pytest", "test", "ptr"}.intersection(sys.argv)
 pytest_runner = ["pytest-runner"] if needs_pytest else []
 
 try:
-    with open("README.md", "r") as handle:
+    with open("README.md") as handle:
         long_description = handle.read()
 except ValueError:
     long_description = short_description
@@ -64,7 +63,7 @@ setup(
     ]
     + pytest_runner,
     # Additional entries you may want simply uncomment the lines you want and fill in the data
-    url="https://github.com/theochem/selector",  # Website
+    url="https://github.com/theochem/Selector",  # Website
     install_requires=[
         "numpy>=1.21.2",
         "scipy==1.11.1",

tox.ini

@@ -79,11 +79,11 @@ deps =
     # black
     bandit
 commands =
-    flake8 selector/ selector/tests setup.py
+    flake8 selector/ selector/test setup.py
     pylint selector --rcfile=tox.ini --disable=similarities
-# black -l 100 --check ./
-# black -l 100 --diff ./
-# Use bandit configuration file
+    # black -l 100 --check ./
+    # black -l 100 --diff ./
+    # Use bandit configuration file
     bandit -r selector -c .bandit.yml
 
 ignore_errors = true

website.yml

@@ -23,10 +23,10 @@ jobs:
     - uses: actions/checkout@v2
 
     # Install dependencies
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v2
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: 3.11
 
     - name: Install dependencies
       run: |
@@ -37,12 +37,12 @@ jobs:
       run: |
         jupyter-book build ./book/content
     # Create an ghp-branch
-    - name ghp branch
+    - name: ghp branch
       run: |
         ghp-import -n -p -f ./book/content/_build/html
 
     # Push the book's HTML to github-pages
-    - name: GitHub Pages action
+    - name: GitHub Pages Action
       uses: peaceiris/[email protected]
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}