cruft sync (#6)

.cruft.json

@@ -0,0 +1,18 @@
+{
+  "template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy",
+  "commit": "2b69298215c08160678dd749884c426a55828dce",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "project_name": "screenpy_pyotp",
+      "readable_name": "ScreenPy PyOTP",
+      "copyright_start": "2022",
+      "is_sub_package": true,
+      "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 }}
 

.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 PyOTP
+      - name: "Build ScreenPy PyOTP"
         run: >-
           python -m
           poetry

.github/workflows/tests.yml

@@ -20,17 +20,17 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+    - 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 dev dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox tox-gh-actions
+    - name: Install dev dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions
 
-      - name: Test with tox
-        run: tox
+    - name: Test with tox
+      run: tox

README.md

@@ -1,6 +1,15 @@
 ScreenPy PyOTP
 ==============
 
+[![Build Status](../../actions/workflows/tests.yml/badge.svg)](../../actions/workflows/tests.yml)
+[![Build Status](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
+
+[![Supported Versions](https://img.shields.io/pypi/pyversions/screenpy_pyotp.svg)](https://pypi.org/project/screenpy_pyotp)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 ```
 TITLE CARD:
                                 "ScreenPy PyOTP"
@@ -48,7 +57,7 @@ or
 
 
 Documentation
-----------
+-------------
 Please check out the [Read The Docs documentation](https://screenpy-pyotp-docs.readthedocs.io/en/latest/) for the latest information about this module!
 
 You can also read the [ScreenPy Docs](https://screenpy-docs.readthedocs.io/en/latest/) for more information about ScreenPy in general.
@@ -58,8 +67,13 @@ Contributing
 ------------
 You want to contribute? Great! Here are the things you should do before submitting your PR:
 
-1. Install [`pre-commit`](https://pre-commit.com/)
-1. run `pre-commit install` once.
-1. run `tox` to perform tests frequently.
+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. Run `pre-commit install` once.
+1. Run `tox` to perform tests frequently.
+1. Create pull-request from your branch.
 
 That's it! :)