Merge pull request ScreenPyHQ#11 from bandophahita/project_standardiz…

…ation

Project standardization

.github/workflows/lint.yml

@@ -23,11 +23,12 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
       - name: Install dependencies
         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 .

.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

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - 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,27 +1,17 @@
 # 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://[email protected]:ScreenPyHQ/screenpy.git#trunk
-
-local_screenpy:
-	pip uninstall screenpy
-	pip install -e ~/projects/screenpy
-
-requirements:
-	poetry export --without-hashes --with dev -f requirements.txt > requirements.txt
-
-.PHONY: sync update trunk_screenpy local_screenpy, requirements
+.PHONY: sync update_lock_only update check
 
 black-check:
 	black --check .
@@ -46,3 +36,22 @@ 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

@@ -1,7 +1,6 @@
 # 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 --------------------------------------------------------------
@@ -13,69 +12,56 @@
 import os
 import sys
 
-
 sys.path.insert(0, os.path.abspath("./ext"))
 sys.path.insert(0, os.path.abspath("../"))
 
-from screenpy_requests.__version__ import __version__  # noqa: need the path first
+from screenpy_requests.__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_requests'
-copyright = '2022-2023, Perry Goy'
-author = 'Perry Goy'
-
-# The full version, including alpha/beta/rc tags
+project = "screenpy_requests"
+copyright = __copyright__
+author = __author__
 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),
-    "requests": ("https://docs.python-requests.org/en/latest/", None),
-}
-
-autodoc_member_order = "bysource"
-
-# 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 = """.. External references
 .. |request| replace:: `Session.request <https://requests.readthedocs.io/en/master/api/#requests.Session.request>`__
 .. |Requests| replace:: `Requests <https://requests.readthedocs.io/en/master/>`__
 """
 
-# 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
 
+html_theme = "sphinx_rtd_theme"
+html_static_path = []
 
-# -- Options for HTML output -------------------------------------------------
+autodoc_member_order = "bysource"
+add_module_names = False
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'default'
 
-# 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']
+# -- Options for intersphinx extension ---------------------------------------
 
-# Other HTML settings
-add_module_names = False
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    "screenpy": ("https://screenpy-docs.readthedocs.io/en/latest/", None),
+    "requests": ("https://docs.python-requests.org/en/latest/", None),
+}

docs/rtd-requirements.txt

@@ -0,0 +1 @@
+-e .

mypy.ini

@@ -2,7 +2,6 @@
 show_error_codes = True
 exclude = (?x)(
           setup\.py
-          ;          | tests/
           | docs/
           )