Merge pull request #7 from lcognat/fix-tests-docs

Fixes tests docs

.github/workflows/check-bandit.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install bandit
+        pip install -e ".[security]"
     - name: Bandit
       run: |
         bandit concrete_mailer -r --exclude tests

.github/workflows/check-black.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install black
+        pip install -e ".[quality]"
     - name: Check black
       run: |
-        black --check concrete_mailer
+        black --check --line-length=79 --skip-string-normalization concrete_mailer

.github/workflows/check-lint.yml

@@ -20,8 +20,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .
-        pip install pylint
+        pip install -e ".[quality]"
     - name: Lint with pylint
       run: |
         pylint -E concrete_mailer

.github/workflows/check-tests.yml

@@ -20,11 +20,10 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .
-        pip install pytest codecov mock pytest-cov
+        pip install -e ".[tests]"
     - name: Test with pytest
       run: |
-        pytest -s concrete_mailer --pyargs -q tests --cov --cov-report html --cov-report term --cov-config tests/.coveragerc
+        pytest -s concrete_mailer --pyargs -q tests --cov --cov-report html --cov-report term
     - name: Tests coverage with CodeCov
       run: |
-        codecov
+        codecov

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # How to contribute
 
-We encourage contributing to this project and we thank you for taking the time to contribute.  
+We encourage contributing to this project and we thank you for taking the time to contribute.
 To do so, please follow our contributing guideline:
 
 ## 1- Submit an issue
@@ -25,9 +25,9 @@ To do so, please follow our contributing guideline:
 ## 3- Submit changes
 -  Push your changes to your branch on your forked repository
 -  Open a pull request to the original repository
--  Reference the issue you handled in your pull request.  
+-  Reference the issue you handled in your pull request.
 :no_entry_sign: **PLEASE DO NOT CLOSE THE ISSUE BY YOURSELF**
--  Assign the pull request to one of the repository maintainers.  
+-  Assign the pull request to one of the repository maintainers.
 :no_entry_sign: **IF YOU ARE ONE OF THE MAINTAINERS, PLEASE DO NOT ACCEPT YOUR OWN PULL REQUESTS UNLESS YOUR CHANGES WERE REVIEWED AND VALIDATED BY AT LEAST ANOTHER MEMBER OF THE PROJECT**
 -  The pull request will be reviewed and discussed before any merge.
 
@@ -38,8 +38,7 @@ To do so, please follow our contributing guideline:
 ```shell
 python3 -m venv env
 source env/bin/activate
-pip install concrete-mailer
-pip install -r tests/requirements.txt
+pip install -e ".[security,quality]"
 ```
 
 ### Ensure black
@@ -51,13 +50,13 @@ pip install -r tests/requirements.txt
 #### format all files:
 
 ```shell
-black --config pyproject.toml .
+black --line-length=79 --skip-string-normalization concrete_mailer
 ```
 
 #### check if all files ar well formatted:
 
 ```shell
-black --check --config pyproject.toml .
+black --check --line-length=79 --skip-string-normalization concrete_mailer
 ```
 
 ### Ensure lint

README.md

@@ -13,15 +13,15 @@
 
 ## Description
 
-:email: `concrete-mailer` is a python package for sending rich e-mails.
+`concrete-mailer` is a python package for sending rich e-mails.
 
 - It automatically embeds the linked image in email inline attachments.
 - It avoids emails to end up in SPAM (applying best practices, with no guarantee)
 - It automatically converts rich e-mails in plain-text format for receivers who have not enabled HTML format
 - It allows sending e-mails with attachements
 - It inlines CSS (no header in HTML e-mails)
 
-:warning: It requires an SMTP server.
+⚠ **warning** It requires an SMTP server.
 
 ## Setup the environment
 

concrete_mailer/__init__.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# coding: utf-8
 from __future__ import unicode_literals
 
 

setup.cfg

@@ -25,3 +25,50 @@ install_requires =
     premailer>=3.6.1,<4
     beautifulsoup4>=4.8.0,<5
     jinja2>=2.10.1,<3
+
+[options.extras_require]
+tests =
+    mock
+    pytest-cov
+    pytest
+    codecov
+security =
+    bandit
+quality =
+    pylint
+    black; python_version >= "3.6"
+
+[coverage:report]
+# With regex
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+    skip-test-coverage
+    # Custom for block
+    PragmaContextNoCover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+    if settings\.DEBUG
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+    raise RuntimeError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+[coverage:run]
+omit =
+    */tests/*
+
+include =
+    *concrete_mailer*
+
+
+[coverage:html]
+title = concrete-mailer - Code coverage
+directory = ./tests/coverage/

tests/README.md

@@ -7,16 +7,15 @@
 ```shell
 python3 -m venv env
 source env/bin/activate
-pip install concrete-mailer
-pip install -r tests/requirements.txt
+pip install -e ".[tests]"
 ```
 
 ### Run the tests
 
 Invoke Pytest with the following args:
 
 ```shell
-pytest -s concrete_mailer --pyargs -q tests --cov --cov-report html --cov-report term --cov-config tests/.coveragerc
+pytest -s concrete_mailer --pyargs -q tests --cov --cov-report html --cov-report term
 ```
 
 You can decide to deactivate coverage