release/1.2.3 (#6)

* Gmail API wrapper (#4)

* Update workspace settings

* Bump and update project dependencies

* Add Gmail API wrapper with GmailMailbox and GmailEmail classes

* Remove unnecessary "Object" from class names

* Fix bugs in worksheet generation and conditional formatting

* Update tests

* Improve kwargs on search messages command to be snake case

* Add to_json method to GmailEmail object

* Update credentials specifications in gitignore

* Improve multipart message handling

* Bump version after improving multipart message handling

* Fix linting errors

* Update linting workflow, errors and tests

* Fix more linting errors

* Improve gmail wrapper (#5)

* Handle multipart messages and case sensitivity of headers

* Bump dependencies

Author: piiq

.github/workflows/codeqa.yml

@@ -23,10 +23,5 @@ jobs:
           key: ${{ runner.os }}-linting
           restore-keys: ${{ runner.os }}-linting
 
-      - run: pip install bandit black codespell flake8 pycodestyle pydocstyle
-      - run: bandit -r googau || true
-      - run: black --check googau
-      - run: codespell googau
-      - run: flake8 googau --count --max-line-length=120 --show-source --statistics
-      - run: pycodestyle googau --ignore=E501
-      - run: pydocstyle googau
+      - run: pip install ruff
+      - run: ruff check googau --config pyproject.toml

.gitignore

@@ -1,3 +1,8 @@
+# Credentials files
+credentials.json
+client_secret*.json
+*token*.pickle
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.vscode/settings.json

@@ -7,52 +7,40 @@
     "files.trimTrailingWhitespace": true,
     "files.trimFinalNewlines": true,
     "files.insertFinalNewline": true,
+    "files.exclude": {
+        "venv/": true,
+        ".mypy_cache/": true,
+        "**/node_modules/": true,
+        "**/__pycache__/": true,
+        "**/.mypy_cache/": true,
+        "**/.pytest_cache/": true,
+        "**/.ruff_cache/": true,
+        "**/.ipynb_checkpoints": true,
+        "**/.DS_Store": true,
+        "**/.scannerwork": true
+    },
     "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.tabSize": 4,
         "editor.insertSpaces": true,
-        "editor.formatOnSave": true
+        "editor.formatOnSave": true,
+        "editor.formatOnPaste": false,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "never",
+            "source.fixAll": "explicit"
+        },
+        "editor.formatOnType": false,
     },
     "python.defaultInterpreterPath": "./venv/bin/python",
-    "python.formatting.provider": "black",
-    "python.linting.enabled": true,
-    "python.linting.flake8Path": "flake8",
-    "python.linting.flake8Enabled": true,
-    "python.linting.flake8CategorySeverity.F": "Error",
-    "python.linting.flake8CategorySeverity.E": "Error",
-    "python.linting.flake8Args": [
-        "--max-line-length=120"
-    ],
-    "python.linting.mypyEnabled": true,
-    "python.linting.mypyPath": "mypy",
-    "python.linting.pylintEnabled": true,
-    "python.linting.banditEnabled": true,
-    "python.linting.banditArgs": [
-        "-x",
-        "./tests",
-        "-r",
-    ],
-    "python.linting.pylintArgs": [
-        "--disable=C0301"
-    ],
-    "python.linting.pycodestyleEnabled": true,
-    "python.linting.pycodestyleArgs": [
-        "--ignore E501"
-    ],
-    "python.linting.pydocstylePath": "pydocstyle",
-    "python.linting.pydocstyleEnabled": false,
-    "python.linting.pydocstyleArgs": [
-        "--convention=numpy"
-    ],
     "python.languageServer": "Pylance",
     "python.testing.pytestArgs": [
         "tests"
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "python.terminal.activateEnvironment": true,
-    "workbench.colorTheme": "Sublime Text 4 Theme",
+    "workbench.colorTheme": "Default Dark Modern",
     "editor.bracketPairColorization.independentColorPoolPerBracketType": true,
-    "workbench.activityBar.visible": true,
     "workbench.preferredDarkColorTheme": "GitHub Dark Dimmed",
     "workbench.preferredLightColorTheme": "GitHub Light Default",
     "workbench.preferredHighContrastLightColorTheme": "Default Light+",

googau/calendar.py

@@ -1,4 +1,5 @@
 """Calendar utilities."""
+
 import datetime
 from typing import Optional
 from googau.sessions import CalendarSession
@@ -14,7 +15,7 @@ class TimeDeltas:
     YTD = datetime.timedelta(days=365)
 
 
-class CalendarObject:
+class Calendar(object):
     """Gets a Calendar object for the current session and an ID."""
 
     calendarId = None
@@ -35,6 +36,7 @@ def __init__(
             The calendar session or None, by default None
         calendarId : Union[str, None], optional
             The calendar id from G-Suite or None, by default None
+
         """
         self.calendarId = calendarId
         self.service = session
@@ -57,6 +59,7 @@ def get_events_td(
         -------
         list
             The list of events
+
         """
         if not date:
             _date = datetime.datetime.utcnow()

googau/documents.py

@@ -1,9 +1,10 @@
 """Document utilities."""
+
 from typing import Optional
 from .sessions import DocSession
 
 
-class DocObject:
+class Doc(object):
     """Gets a Document object for the current session and an ID."""
 
     documentId: Optional[str] = None
@@ -19,6 +20,7 @@ def __init__(self, session=None, documentId=None):
             The Google Docs API session to use, by default None
         documentId : Optional[str], optional
             The document id from Google Docs, by default None
+
         """
         self.documentId = documentId
         self.session = session

googau/drive.py

@@ -6,7 +6,7 @@
 from .constants.drive_constants import SHARED_DRIVE
 
 
-class SharedDriveObject(object):
+class SharedDrive(object):
     """SharedDrive object for the current session and an ID."""
 
     drive_id: Optional[str] = None
@@ -21,6 +21,7 @@ def __init__(self, session: DriveSession, drive_id: Optional[str] = None):
             A DriveSession instance
         drive_id : Optional[str], optional
             The shared drive id from G-Suite, by default None
+
         """
         self.drive_id = drive_id
         self.session = session
@@ -48,6 +49,7 @@ def create(self, request_id: str, name: str, **kwargs) -> dict:
         -------
         dict
             The response from the API call.
+
         """
         drive_template = copy.deepcopy(SHARED_DRIVE)
         drive_template["name"] = name
@@ -67,6 +69,7 @@ def hide(self) -> dict:
         -------
         dict
             The response from the API call.
+
         """
         if self.drive_id is None:
             return {"error": "No Drive ID provided."}
@@ -80,6 +83,7 @@ def unhide(self) -> dict:
         -------
         dict
             The response from the API call.
+
         """
         if self.drive_id is None:
             return {"error": "No Drive ID provided."}