Modifying CICD to use pre-commit

Author: Peter McDonald

.editorconfig

@@ -21,4 +21,4 @@ jobs:
         pip install mypy types-Jinja2
     - name: mypy
       run: |
-        mypy monzo/
+        mypy monzo/

.github/workflows/mypy.yml

@@ -0,0 +1,19 @@
+name: pre-commit
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - 'master'
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+    - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yml

@@ -0,0 +1,33 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: check-merge-conflict
+    - id: check-case-conflict
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+    name: isort
+
+- repo: https://github.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+  - id: flake8
+    name: flake8
+    additional_dependencies:
+    - flake8-bugbear
+    - flake8-no-pep420
+    - flake8-comprehensions
+    - flake8-docstrings
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: 'v0.940'
+  hooks:
+  - id: mypy
+    name: mypy

.pre-commit-config.yaml

@@ -57,4 +57,4 @@ Change Log
 
 **0.0.1**
 
-- Initial minimal release
+- Initial minimal release

CHANGELOG.rst

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

LICENSE

@@ -0,0 +1 @@
+"""Standard blank module __init__."""

docs/source/__init__.py

@@ -180,4 +180,4 @@ Open the Monzo app and you will see something like:
 
 Click on "Approve"
 
-Congratulations, you now have credentials that you can use to query the API.
+Congratulations, you now have credentials that you can use to query the API.

docs/source/access_token.rst

@@ -54,5 +54,3 @@ these contain either a fetch or fetchone class method that will carry out
 a query and return a list of objects matching your query.
 
 You now have a list of accounts that you can inspect and work with.
-
-

docs/source/basic_api_queries.rst

@@ -1 +1 @@
-.. include:: ../../CHANGELOG.rst
+.. include:: ../../CHANGELOG.rst

docs/source/changelog.rst

@@ -1,13 +1,16 @@
-# 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:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
+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:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 
 import datetime
 import os
 import sys
 from configparser import ConfigParser
+from typing import List
 
 # -- Path setup --------------------------------------------------------------
 
@@ -32,15 +35,15 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions: List[str] = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path: List[str] = ['_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 = []
+exclude_patterns: List[str] = []
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/conf.py

@@ -7,6 +7,30 @@ financials.
 
 The Monzo API package helps simplify usage of the API.
 
+CICD and Code Standards
+-------------------------------------
+
+We have attempted to reduce the work required to ensure the code conforms to
+our coding standards. You can help ensure that any code changes will pass
+CICD by making use of pre-commit. The following steps will set this up for you:
+
+.. code-block:: bash
+
+    pip install pre-commit
+    pre-commit install
+    pre-commit run --all-file
+
+The above commands will create pre-commit hooks, this will test the code prior
+to code being committed by Git. Some of the tasks will even correct the data
+instead of throwing an error.
+
+If you would like to run the checks without cmmitting code you can run the
+following command:
+
+.. code-block:: bash
+
+    pre-commit run --all-file
+
 Building Documentation
 -------------------------------------
 
@@ -60,4 +84,3 @@ You can now run the following to upload the package.
     git pull
     pip install -e .[build]
     twine upload dist/*
-

docs/source/developers.rst

@@ -0,0 +1 @@
+"""Standard blank module __init__."""

examples/__init__.py

@@ -1,3 +1,4 @@
+"""Example code to authenticate against the Monzo API."""
 from monzo.authentication import Authentication
 
 client_id = ''  # Client ID obtained when creating Monzo client

examples/auth_step_01.py

@@ -1,3 +1,4 @@
+"""Code to handle the seconds stage of authentication."""
 from monzo.authentication import Authentication
 from monzo.exceptions import MonzoAuthenticationError, MonzoServerError
 

examples/auth_step_02.py

@@ -1,3 +1,4 @@
+"""Example code for creating a feed item."""
 from monzo.authentication import Authentication
 from monzo.endpoints.account import Account
 from monzo.endpoints.feed_item import FeedItem

examples/create_feed_item.py

@@ -1,3 +1,4 @@
+"""Example code to fetch accounts."""
 from monzo.authentication import Authentication
 from monzo.endpoints.account import Account
 from monzo.exceptions import MonzoError

examples/get_accounts.py

@@ -1,3 +1,4 @@
+"""Example code for showing who is logged into the Monzo API."""
 from monzo.authentication import Authentication
 from monzo.endpoints.whoami import WhoAmI
 from monzo.exceptions import MonzoError

examples/get_whoami.py

@@ -0,0 +1 @@
+"""Standard blank module __init__."""

monzo/__init__.py

@@ -1,3 +1,4 @@
+"""Class to allow authentication on the Monzo API."""
 import logging
 import os
 from pathlib import Path, PurePath
@@ -21,6 +22,7 @@ class Authentication(object):
     Class provides methods to authenticate to the Monzo API and to make relevant queries. An instantiated
     copy of this class is usually passed to each action
     """
+
     __slots__ = [
         '_access_token',
         '_access_token_expiry',
@@ -41,7 +43,7 @@ def __init__(
             refresh_token: str = ''
     ):
         """
-        Standard init.
+        Initialize Authentication.
 
         Args:
             client_id: Client ID generated at https://developers.monzo.com
@@ -83,9 +85,7 @@ def authenticate(self, authorization_token: str, state_token: str) -> None:
         self._exchange_token(authorization_token=authorization_token)
 
     def logout(self) -> None:
-        """
-        Invalidates the access token.
-        """
+        """Invalidate the access token."""
         logging.debug('Invalidating token')
         self.make_request(path='/oauth2/logout')
 
@@ -99,7 +99,7 @@ def make_request(
             timeout: int = DEFAULT_TIMEOUT
     ) -> REQUEST_RESPONSE_TYPE:
         """
-        Makes an API call to Monzo.
+        Make an API call to Monzo.
 
         Args:
             path: Path for the API call
@@ -212,7 +212,7 @@ def refresh_token(self) -> str:
     @property
     def state_token(self) -> str:
         """
-        Generates or returns a previously generated state token.
+        Generate or returns a previously generated state token.
 
         Returns:
             A state token used for authentication requests.
@@ -255,7 +255,7 @@ def _exchange_token(self, authorization_token: str) -> None:
 
     def _populate_tokens(self, response: REQUEST_RESPONSE_TYPE) -> None:
         """
-        Populates tokens after a token request.
+        Populate tokens after a token request.
 
         Args:
             response: Response from an auth request.
@@ -278,7 +278,7 @@ def _populate_tokens(self, response: REQUEST_RESPONSE_TYPE) -> None:
 
     def register_callback_handler(self, handler: Storage) -> None:
         """
-        Registers a new callback handler for handling new token details.
+        Register a new callback handler for handling new token details.
 
         Args:
             handler: Credential handler implementing Storage

monzo/authentication.py

@@ -0,0 +1 @@
+"""Standard blank module __init__."""

monzo/endpoints/__init__.py

@@ -1,3 +1,4 @@
+"""Class to manage Accounts."""
 from __future__ import annotations
 
 from datetime import datetime
@@ -29,11 +30,12 @@ class Account(Monzo):
     Class provides methods to fetch accounts and related information. To properly utilise the
     class the fetch class method should be utilised.
     """
+
     __slots__ = ['_account_id', '_auth', '_balance', '_created', '_description', '_has_balance']
 
     def __init__(self, auth: Authentication, account_id: str, description: str, created: datetime):
         """
-        Standard init
+        Initialize Account.
 
         Args:
             account_id: ID of the account
@@ -108,7 +110,7 @@ def description(self) -> str:
     @classmethod
     def fetch(cls, auth: Authentication, account_type: str = None) -> List[Account]:
         """
-        Implements and instantiates a Account object
+        Implement and instantiates a Account object.
 
         Args:
              auth: Monzo authentication object

monzo/endpoints/account.py

@@ -1,3 +1,4 @@
+"""Class to manage Attachments."""
 from __future__ import annotations
 
 from datetime import datetime
@@ -22,6 +23,7 @@ class Attachment(Monzo):
 
     Class provides methods to manage attachments.
     """
+
     __slots__ = [
         '_attachment_id',
         '_user_id',
@@ -42,7 +44,7 @@ def __init__(
             created: datetime
     ):
         """
-        Standard init.
+        Initialize Attachment.
 
         Args:
             auth: Monzo authentication object
@@ -112,9 +114,7 @@ def created(self) -> datetime:
         return self._created
 
     def delete(self) -> None:
-        """
-        Delete the attachment.
-        """
+        """Delete the attachment."""
         data = {
             'id': self.attachment_id
         }
@@ -189,7 +189,6 @@ def _upload_file(cls, auth: Authentication, url: str, file_type: str) -> str:
         Returns:
             URL of the uploaded file
         """
-
         if not isfile(url):
             raise MonzoGeneralError('File does not exist')
         content_length = getsize('url')

monzo/endpoints/attachment.py

@@ -1,3 +1,4 @@
+"""Class to manage balance."""
 from __future__ import annotations
 
 from monzo.authentication import Authentication
@@ -12,11 +13,12 @@ class Balance(Monzo):
     utilised along with the balance property. Otherwise you can fetch an accounts balance utilising the fetch
     class method.
     """
+
     __slots__ = ['_balance', '_total_balance', '_currency', '_spend_today']
 
     def __init__(self, auth: Authentication, balance: int, total_balance: int, currency: str, spend_today: str):
         """
-        Standard init
+        Initialize Balance.
 
         Args:
             balance: Balance of the account
@@ -73,7 +75,7 @@ def spend_today(self) -> str:
     @classmethod
     def fetch(cls, auth: Authentication, account_id: str) -> Balance:
         """
-        Implements and instantiates a Account object.
+        Implement and instantiates a Account object.
 
         Args:
              auth: Monzo authentication object