Cruft (#131)

* cruft sync

.cruft.json

@@ -0,0 +1,18 @@
+{
+  "template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy/",
+  "commit": "2b69298215c08160678dd749884c426a55828dce",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "project_name": "screenpy",
+      "readable_name": "ScreenPy",
+      "copyright_start": "2019",
+      "is_sub_package": false,
+      "author": "Perry Goy",
+      "author_email": "[email protected]",
+      "github_username": "ScreenPyHQ",
+      "_template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy/"
+    }
+  },
+  "directory": null
+}

.github/workflows/cruft.yml

@@ -0,0 +1,34 @@
+name: Cruft
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+      - name: Run Cruft
+        run: |
+          cruft check

.github/workflows/lint.yml

@@ -18,9 +18,9 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'

.github/workflows/poetry.yml

@@ -21,9 +21,9 @@ jobs:
         poetry-version: ["1.6.1"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -34,6 +34,6 @@ jobs:
 
       - name: Check toml structure
         run: poetry check
-        
+
       - name: Check lock file
         run: poetry lock --check

.github/workflows/publish.yml

@@ -12,9 +12,9 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
       - name: Install Poetry
@@ -23,7 +23,7 @@ jobs:
           pip install
           poetry
           --user
-      - name: Build ScreenPy
+      - name: "Build ScreenPy"
         run: >-
           python -m
           poetry

.github/workflows/tests.yml

@@ -20,9 +20,9 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         cache: 'pip'

.pre-commit-config.yaml

@@ -7,6 +7,7 @@ repos:
       - id: black
         language_version: python3.12
   - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
     rev: v0.2.0
     hooks:
       - id: ruff

README.md

@@ -1,5 +1,6 @@
 ScreenPy
 ========
+
 [![Build Status](../../actions/workflows/tests.yml/badge.svg)](../../actions/workflows/tests.yml)
 [![Build Status](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
 
@@ -53,7 +54,7 @@ Installation
 
 
 Documentation
-----------
+-------------
 Please check out the [Read The Docs documentation](https://screenpy-docs.readthedocs.io/en/latest/) for the latest information about this module!
 
 
@@ -63,9 +64,9 @@ You want to contribute? Great! Here are the things you should do before submitti
 
 1. Fork the repo and git clone your fork.
 1. `dev` install the project package:
-   1. `pip install -e .[dev]` 
-   1. Optional (poetry users):
-      1. `poetry install --extras dev`
+    1. `pip install -e .[dev]`
+    1. Optional (poetry users):
+        1. `poetry install --extras dev`
 1. Run `pre-commit install` once.
 1. Run `tox` to perform tests frequently.
 1. Create pull-request from your branch.