Project standardization

.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_playwright
-          black --check --diff tests
-      - name: Lint with mypy
-        run: |
-          mypy screenpy_playwright
-          mypy tests
+          black --check --diff .
       - name: Lint with ruff
         run: |
           ruff check .
+      - name: Lint with mypy
+        run: |
+          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/

.pre-commit-config.yaml

@@ -1,18 +1,19 @@
-exclude: 'docs'
+files: '(screenpy_playwright|tests)/.*'
 fail_fast: false
 repos:
-- repo: https://github.com/psf/black
-  rev: 24.1.1
-  hooks:
-  - id: black
-    language_version: python3.12
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.2.0
-  hooks:
-    - id: ruff
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.8.0
-  hooks:
-  - id: mypy
-    language_version: python3.12
+  - repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+      - id: black
+        language_version: python3.12
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.2.0
+    hooks:
+      - id: ruff
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        language_version: python3.12
 

.readthedocs.yaml

@@ -10,4 +10,7 @@ sphinx:
 
 python:
   install:
-    - requirements: docs/rtd-requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

Makefile

@@ -1,28 +1,25 @@
 # 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
 
-requirements:
-	poetry export --without-hashes --with dev -f requirements.txt > requirements.txt
-
-.PHONY: sync update_lock_only update check requirements
+.PHONY: sync update_lock_only update check
 
 black-check:
 	black --check .
 
-black:
+black-fix:
 	black .
 
-ruff:
+ruff-check:
 	ruff check .
 
 ruff-fix:
@@ -31,12 +28,28 @@ ruff-fix:
 mypy:
 	mypy .
 
-lint: ruff mypy
-
-.PHONY: black-check black ruff ruff-fix mypy lint
+.PHONY: black-check black-fix ruff-check ruff-fix mypy
 
-pre-check-in: black-check lint
+pre-check-in: black-check ruff-check mypy
 
-pre-check-in-fix: black ruff-fix 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://[email protected]:ScreenPyHQ/screenpy.git#trunk
+
+local_screenpy:
+	pip uninstall screenpy
+	pip install -e ~/projects/screenpy
+
+.PHONY: trunk_screenpy local_screenpy

docs/conf.py

@@ -13,20 +13,23 @@
 import os
 import sys
 
-
 sys.path.insert(0, os.path.abspath("./ext"))
 sys.path.insert(0, os.path.abspath("../"))
 
-from screenpy_playwright.__version__ import __version__  # noqa: need the path first
+from screenpy_playwright.__version__ import (
+    __version__,
+    __author__,
+    __copyright__,
+)  # noqa: need the path first
 
-autodoc_mock_imports = ["playwright", "screenpy", ]
+autodoc_mock_imports = ["playwright", "screenpy"]
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'screenpy_playwright'
-copyright = '2022-2023, Perry Goy'
-author = 'Perry Goy'
+project = "screenpy_playwright"
+copyright = __copyright__
+author = __author__
 
 # The full version, including alpha/beta/rc tags
 release = __version__
@@ -50,15 +53,28 @@
     "selenium": ("https://selenium-python.readthedocs.io/", None),
 }
 
-autodoc_member_order = "bysource"
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+
+
+
+
+
+
+
+
+
+
+
+
 # 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']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -71,7 +87,7 @@
 # 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']
+html_static_path = ["_static"]
 
 # Other HTML settings
 autodoc_member_order = "bysource"

mypy.ini

@@ -1,11 +1,13 @@
 [mypy]
 show_error_codes = True
 exclude = (?x)(
-          docs/
+          setup\.py
+          | docs/
           )
 
 [mypy-screenpy_playwright.*]
 disallow_untyped_defs = True
 
 [mypy-tests.*]
+disallow_untyped_defs = True
 ignore_missing_imports = True