Merge/tvsw (#33)

* Edit docs coverage badge

* Add tests with branch coverage

* Update readme

* Add lint with flake8

* Fix bug where the exception sent as a message was not the one originally thrown

* Add support for Imgur gallery images

* Add mypy type checking

* Add DbC

* Add dev dependencies

* Add github pages workflow

* Add git-crypt to lint

* Add pyreverse

* Update failing test due to API error

* Add icontract linting

Author: fabiosangregorio

.codeclimate.yml

@@ -2,10 +2,10 @@ version: "2"
 checks:
   argument-count:
     config:
-      threshold: 5
+      threshold: 7
   method-complexity:
     config:
-      threshold: 7
+      threshold: 15
 plugins:
   duplication:
     enabled: true
@@ -20,17 +20,5 @@ plugins:
     config: 
       threshold: "C"
 exclude_patterns:
-  - "config/"
-  - "db/"
-  - "dist/"
-  - "features/"
-  - "**/node_modules/"
-  - "script/"
-  - "**/spec/"
-  - "**/test/"
   - "**/tests/"
-  - "Tests/"
-  - "**/vendor/"
-  - "**/*_test.go"
-  - "**/*.d.ts"
   - "**/secret_*.py"

.github/workflows/docs.yml

@@ -26,22 +26,15 @@ jobs:
       uses: actions/cache@v1
       with:
         path: ~/.cache/pip # This path is specific to Ubuntu
-        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-
-    - name: Cache CI dependencies
-      uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip # This path is specific to Ubuntu
-        key: ${{ runner.os }}-pip-${{ hashFiles('./.github/workflows/requirements/docs.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements/requirements.txt') }}-${{ hashFiles('**/docs.txt') }}-${{ hashFiles('**/test.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip-
 
     - name: Install dependencies
       run: |
-        pip install -r requirements.txt
-        pip install -r ./.github/workflows/requirements/docs.txt
+        pip install -r ./requirements/requirements.txt
+        pip install -r ./requirements/docs.txt
+        pip install -r ./requirements/test.txt
 
     - name: Unlock git-crypt files
       uses: zemuldo/[email protected]
@@ -50,35 +43,37 @@ jobs:
         GPG_KEY_GRIP: ${{ secrets.GPG_KEY_GRIP }}
         GPG_KEY_PASS: ${{ secrets.GPG_KEY_PASS }} 
 
+    - name: Generate project dependency graphs
+      run: |
+        pyreverse --ignore="tests" -o png -p telereddit telereddit
+        mv classes_telereddit.png docs/images/classes_telereddit.png
+        mv packages_telereddit.png docs/images/packages_telereddit.png
+        
     - name: Generate documentation
       run: |
         rm -rf docs/telereddit
         pdoc --html --output-dir="docs/" --template-dir="docs/templates" --config show_source_code=False --force .
       env:
         TELEREDDIT_MACHINE: GITHUB
 
-    - name: Run documentation coverage
+    - name: Run docstr coverage
       run: |
         mkdir documentation-reports
-        docstr-coverage telereddit --percentage-only --exclude=tests --skipinit 2>&1 | tee ./documentation-reports/docstr-coverage.txt
+        docstr-coverage telereddit --verbose=3 --exclude=tests --skipinit 2>&1 | tee ./documentation-reports/docstr-coverage.txt
+    
+    - name: Run pydocstyle
+      run: |
         (pydocstyle telereddit 2>&1 | tee ./documentation-reports/pydocstyle-coverage.txt; exit ${PIPESTATUS[0]})
 
     - name: Upload documentation reports as artifact
       uses: actions/upload-artifact@v2
       with:
         name: documentation-reports
-        path: ./documentation-reports/
+        path: ./documentation-reports/docstr-coverage.txt
 
     - name: Commit changes
       uses: EndBug/add-and-commit@v4
       with:
         message: "Commit from Github Actions: docs workflow changes"
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Deploy docs to Gtihub Pages
-      uses: JamesIves/github-pages-deploy-action@releases/v3
-      with:
-        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-        BRANCH: gh-pages
-        FOLDER: docs/telereddit
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/github-pages.yml

@@ -0,0 +1,52 @@
+name: github-pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+      
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip # This path is specific to Ubuntu
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements/requirements.txt') }}-${{ hashFiles('**/docs.txt') }}-${{ hashFiles('**/test.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        pip install -r ./requirements/requirements.txt
+        pip install -r ./requirements/docs.txt
+        pip install -r ./requirements/test.txt
+
+    - name: Unlock git-crypt files
+      uses: zemuldo/[email protected]
+      env: 
+        GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+        GPG_KEY_GRIP: ${{ secrets.GPG_KEY_GRIP }}
+        GPG_KEY_PASS: ${{ secrets.GPG_KEY_PASS }} 
+
+    - name: Generate documentation
+      run: |
+        rm -rf docs/telereddit
+        pdoc --html --output-dir="docs/" --template-dir="docs/templates" --config show_source_code=False --force .
+      env:
+        TELEREDDIT_MACHINE: GITHUB
+
+    - name: Deploy docs to Github Pages
+      uses: JamesIves/github-pages-deploy-action@releases/v3
+      with:
+        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        BRANCH: gh-pages
+        FOLDER: docs/telereddit

.github/workflows/lint.yml

@@ -18,20 +18,33 @@ jobs:
       with:
         python-version: 3.8
 
-    - name: Cache CI dependencies
+    - name: Cache dependencies
       uses: actions/cache@v1
       with:
         path: ~/.cache/pip # This path is specific to Ubuntu
-        key: ${{ runner.os }}-pip-${{ hashFiles('./.github/workflows/requirements/lint.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements/lint.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip-
 
     - name: Install dependencies
       run: |
-        pip install -r ./.github/workflows/requirements/lint.txt
+        pip install -r ./requirements/lint.txt
+
+    - name: Unlock git-crypt files
+      uses: zemuldo/[email protected]
+      env: 
+        GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+        GPG_KEY_GRIP: ${{ secrets.GPG_KEY_GRIP }}
+        GPG_KEY_PASS: ${{ secrets.GPG_KEY_PASS }} 
 
     - name: Check black code formatting
       run: python -m black telereddit --check
 
     - name: Check flake8 linting
-      run: python -m flake8 --config setup.cfg telereddit
+      run: python -m flake8 --config setup.cfg telereddit
+    
+    - name: Check mypy linting
+      run: mypy telereddit
+
+    - name: Check icontract linting
+      run: pyicontract-lint --format verbose telereddit

.github/workflows/requirements/docs.txt

@@ -33,22 +33,14 @@ jobs:
       uses: actions/cache@v1
       with:
         path: ~/.cache/pip # This path is specific to Ubuntu
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-
-    - name: Cache CI dependencies
-      uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip # This path is specific to Ubuntu
-        key: ${{ runner.os }}-pip-${{ hashFiles('./.github/workflows/requirements/test.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements/requirements.txt') }}-${{ hashFiles('**/test.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip-
 
     - name: Install dependencies
       run: |
-        pip install -r requirements.txt
-        pip install -r ./.github/workflows/requirements/test.txt
+        pip install -r ./requirements/requirements.txt
+        pip install -r ./requirements/test.txt
 
     - name: Run tests and generate report
       run: | 

.github/workflows/requirements/lint.txt

@@ -3,9 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -25,16 +22,6 @@ wheels/
 *.egg
 MANIFEST
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -47,40 +34,6 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
 # Environments
 .env
 .venv
@@ -103,10 +56,17 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+.mypy
 
+# IDE
 .vscode
 .idea
 
+# Python
 __pycache__
 
-documentation-reports
+documentation-reports
+
+html
+.mutmut-cache
+.metadata

.github/workflows/requirements/test.txt

@@ -60,6 +60,14 @@ Get it on [telegram.me](https://telegram.me/tele_reddit_bot)!
 
 ## Bugs and feature requests
 If you want to report a bug or would like a feature to be added, feel free to open an issue.
+
+
+## Versioning
+We follow Semantic Versioning. The version X.Y.Z indicates:
+
+* X is the major version (backward-incompatible),
+* Y is the minor version (backward-compatible), and
+* Z is the patch version (backward-compatible bug fix).
 
 ## License
 **[GPL v3](https://www.gnu.org/licenses/gpl-3.0)** - Copyright 2020 © <a href="http://fabio.sangregorio.dev"