ci: add test and deploy jobs

Author: sumnerevans

.github/workflows/python.yaml

@@ -1,15 +1,17 @@
-# Tests on Python 3.7+
-name: Python Test
+name: Python
 
 on:
   push:
     branches: [ "*" ]
   pull_request:
     branches: [ master ]
+  release:
+    types:
+      - created
 
 jobs:
-  build:
-
+  lint:
+    name: Run linters
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -41,3 +43,71 @@ jobs:
       if: always()
       run: |
         poetry run mypy .
+
+    - name: Run custom style checks
+      if: always()
+      run: |
+        poetry run cicd/custom_style_check.py
+
+  # test:
+  #   name: Run the tests
+  #   runs-on: ubuntu-latest
+  #   strategy:
+  #     matrix:
+  #       python-version: [ 3.7, 3.8, 3.9 ]
+
+  #   steps:
+  #   - uses: actions/checkout@v2
+  #   - name: Set up Python ${{ matrix.python-version }}
+  #     uses: actions/setup-python@v2
+  #     with:
+  #       python-version: ${{ matrix.python-version }}
+  #   - name: Run image
+  #     uses: abatilo/[email protected]
+  #   - name: Run pytest
+  #     run: |
+  #       poetry run pytest -vv
+
+  build:
+    name: Build linkedin_messaging
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ 3.7, 3.8, 3.9 ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Run image
+      uses: abatilo/[email protected]
+    - name: Run build
+      run: |
+        poetry build
+
+  deploy:
+    name: Deploy to pypi
+    runs-on: ubuntu-latest
+    needs: [lint, build]
+    if: ${{ github.event_name == 'release' && github.event.action == 'created' }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Run image
+      uses: abatilo/[email protected]
+
+    - name: Dry run publish
+      run: |
+        poetry config pypi-token.pypi ${{ secrets.PYPI_DEPLOY_TOKEN }}
+        poetry publish --build --dry-run
+
+    - name: Actual publish
+      run: |
+        poetry config pypi-token.pypi ${{ secrets.PYPI_DEPLOY_TOKEN }}
+        poetry publish --build

CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.1.0
+
+This is the initial release. Features include:
+
+* Login helper and session manager. Works with 2FA.
+* Get a list of the user's conversations.
+* Retrieve the messages and media in a particular conversation.
+* Send messages to a particular conversation or set of recipients. Multimedia is
+  supported.
+* An event listener structure for listening for new events.

cicd/custom_style_check.py

@@ -0,0 +1,79 @@
+#! /usr/bin/env python
+
+"""
+Checks for TODO comments and makes sure they have an associated issue. Formats that are
+accepted are:
+
+TODO (#1)
+TODO (#1)
+TODO (project#1)
+TODO (namespace/project#1)
+TODO (namespace/namespace/project#1)
+
+Additionally, the TODO can be postfixed with ``:``.
+"""
+
+import re
+import sys
+from pathlib import Path
+from typing import Pattern
+
+from termcolor import cprint
+
+todo_re = re.compile(r"\s*#\s*TODO:?\s*")
+accounted_for_todo = re.compile(r"\s*#\s*TODO:?\s*\(([\w-]+(/[\w-]+)*)?#\d+\)")
+
+
+def noqa_re(error_id: str = "") -> Pattern:
+    return re.compile(rf"#\s*noqa(:\s*{error_id})?\s*\n$")
+
+
+def eprint(*strings):
+    cprint(" ".join(strings), "red", end="", attrs=["bold"])
+
+
+def check_file(path: Path) -> bool:
+    print(f"Checking {path.absolute()}...")  # noqa: T001
+    file = path.open()
+    valid = True
+
+    for i, line in enumerate(file, start=1):
+        if todo_re.match(line) and not accounted_for_todo.match(line):
+            eprint(f"{i}: {line}")
+            valid = False
+
+    file.close()
+    return valid
+
+
+valid = True
+for path in Path("linkedin_messaging").glob("**/*.py"):
+    valid &= check_file(path)
+
+for path in Path("tests").glob("**/*.py"):
+    valid &= check_file(path)
+
+"""
+Checks that the version in the CHANGELOG is the same as the version in ``__init__.py``.
+"""
+with open(Path("linkedin_messaging/__init__.py")) as f:
+    for line in f:
+        if line.startswith("__version__"):
+            version = eval(line.split()[-1])
+            break
+    else:  # nobreak
+        raise AssertionError("No version in linkedin_messaging/__init__.py")
+
+with open(Path("pyproject.toml")) as f:
+    for line in f:
+        if line.startswith("version ="):
+            assert eval(line.split()[-1]) == version, "Version mismatch: pyproject.toml"
+            break
+    else:  # nobreak
+        raise AssertionError("No version in pyproject.toml")
+
+with open(Path("CHANGELOG.md")) as f:
+    assert f.readline().strip() == f"# v{version}", "Version mismatch: CHANGELOG"
+
+
+sys.exit(0 if valid else 1)