Project standardization (ScreenPyHQ#51)

* rearrange pyproject for easier sync between packages
* sync tox.ini
* sync mypy.ini
* sync lint.yaml
* sync poetry.yml
* sync .gitignore
* test__version__.py
* avoiding ScreenPyHQ#36
* adding copyright year test
* sync conf.py
* setting up docs installation via pyproject.toml
* centering ascii art
* adjusting boilerplate pyproject.toml
* cleaner test format
* sync conf.py
* adding license copyright test
* sync pyproject.toml
* adding test for copyright in `__init__.py`

.github/workflows/lint.yml

@@ -28,15 +28,13 @@ jobs:
         shell: bash
         run: |
           python -m pip install --upgrade pip
-          pip install -e .[dev-all]
+          pip install -e .[dev]
       - name: Lint with black
         run: |
-          black --check --diff screenpy_selenium
-          black --check --diff tests
+          black --check --diff .
       - name: Lint with ruff
         run: |
           ruff check .
       - name: Lint with mypy
         run: |
-          mypy screenpy_selenium
-          mypy tests
+          mypy .

.github/workflows/poetry.yml

@@ -34,6 +34,6 @@ jobs:
 
       - name: Check toml structure
         run: poetry check
-        
+
       - name: Check lock file
         run: poetry lock --check

.gitignore

@@ -144,3 +144,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# ruff linter
+.ruff_cache/

.readthedocs.yaml

@@ -3,11 +3,14 @@ version: 2
 build:
   os: "ubuntu-20.04"
   tools:
-    python: "3.11"
+    python: "3.12"
 
 sphinx:
   configuration: docs/conf.py
 
 python:
   install:
-    - requirements: docs/rtd-requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Perry Goy
+Copyright (c) 2022-2024 Perry Goy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,24 +1,17 @@
-# shortcuts
+# shortcuts to help manage flipping between branches with different dependencies
 sync:
-	poetry install --extras dev_all --sync
+	poetry install --extras dev --sync
 
 update_lock_only:
 	poetry update --lock
 
 update: update_lock_only
-	poetry install --extras dev_all
+	poetry install --extras dev
 
 check:
 	poetry check
 
-trunk_screenpy:
-	poetry add screenpy git+ssh://git@github.com:ScreenPyHQ/screenpy.git#trunk
-
-local_screenpy:
-	pip uninstall screenpy
-	pip install -e ~/projects/screenpy
-
-.PHONY: sync update trunk_screenpy local_screenpy
+.PHONY: sync update_lock_only update check
 
 black-check:
 	black --check .
@@ -42,3 +35,21 @@ pre-check-in: black-check ruff-check mypy
 pre-check-in-fix: black-fix ruff-fix mypy
 
 .PHONY: pre-check-in pre-check-in-fix
+
+# requires poetry-plugin-export
+requirements:
+	poetry export --without-hashes --extras dev -f requirements.txt > requirements.txt
+
+.PHONY: requirements
+
+################################################################################
+# sub-package specific
+
+trunk_screenpy:
+	poetry add screenpy git+ssh://git@github.com:ScreenPyHQ/screenpy.git#trunk
+
+local_screenpy:
+	pip uninstall screenpy
+	pip install -e ~/projects/screenpy
+
+.PHONY: trunk_screenpy local_screenpy

docs/conf.py

@@ -1,57 +1,47 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 
 # 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-
+#
 import os
 import sys
 
-
 sys.path.insert(0, os.path.abspath("./ext"))
 sys.path.insert(0, os.path.abspath("../"))
 
-from screenpy_selenium.__version__ import __version__, __author__, __copyright__  # noqa: need the path first
+from screenpy_selenium.__version__ import __version__, __author__, __copyright__
 
 autodoc_mock_imports = ["selenium", "screenpy", "screenpy_pyotp"]
 
 
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'screenpy_selenium'
+project = "screenpy_selenium"
 copyright = __copyright__
 author = __author__
-
-# The full version, including alpha/beta/rc tags
 release = __version__
 
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
-    "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
     "autodoc_skip_protocols",
 ]
 
-intersphinx_mapping = {
-    "screenpy": ("https://screenpy-docs.readthedocs.io/en/latest/", None),
-    "selenium": ("https://selenium-python.readthedocs.io/", None),
-    "screenpy_pyotp": ("https://screenpy-pyotp-docs.readthedocs.io/en/latest/", None),
-}
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 rst_prolog = """.. Substitutions
 
@@ -62,24 +52,21 @@
 .. |ActionChains| replace:: :external+selenium:class:`~selenium.webdriver.common.action_chains.ActionChains`
 """
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
 # -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'default'
+html_theme = "sphinx_rtd_theme"
+html_static_path = []
 
-# 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']
-
-# Other HTML settings
 autodoc_member_order = "bysource"
 add_module_names = False
+
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    "screenpy": ("https://screenpy-docs.readthedocs.io/en/latest/", None),
+    "selenium": ("https://selenium-python.readthedocs.io/", None),
+    "screenpy_pyotp": ("https://screenpy-pyotp-docs.readthedocs.io/en/latest/", None),
+}

mypy.ini

@@ -2,12 +2,12 @@
 show_error_codes = True
 exclude = (?x)(
           setup\.py
-;          | tests/
           | docs/
           )
 
 [mypy-screenpy_selenium.*]
 disallow_untyped_defs = True
 
 [mypy-tests.*]
+disallow_untyped_defs = True
 ignore_missing_imports = True