Merge pull request #27 from digitronik/enhance_nox

RFR: Enhancement in nox

Author: amolkahat

.github/workflows/main.yml

@@ -43,8 +43,10 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
 
-      - name: Install nox
-        run: python -m pip install nox
+      - name: Setup Package and Install Devel Dependencies
+        run: |
+          python -m pip install -Ur dev-requirements.txt
+          python -m pip install .
 
-      - name: Run nox
-        run: nox
+      - name: Unit Tests
+        run: py.test -v tests

.pre-commit-config.yaml

@@ -1,23 +1,23 @@
 repos:
 - repo: https://github.com/asottile/reorder_python_imports
-  rev: v1.6.1
+  rev: v1.9.0
   hooks:
   - id: reorder-python-imports
     language_version: python3
 - repo: https://github.com/psf/black
-  rev: 19.3b0
+  rev: 19.10b0
   hooks:
   - id: black
     args: [--safe, --quiet, --line-length, "100"]
     language_version: python3
     require_serial: true
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.2.3
+  rev: v2.5.0
   hooks:
   -   id: flake8
       verbose: true
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.3.0
+  rev: v2.5.0
   hooks:
   - id: trailing-whitespace
     language_version: python3
@@ -28,7 +28,7 @@ repos:
   - id: flake8
     language_version: python3
 - repo: https://github.com/asottile/pyupgrade
-  rev: v1.22.1
+  rev: v1.26.2
   hooks:
   - id: pyupgrade
     language_version: python3

CONTRIBUTING.md

@@ -51,15 +51,22 @@ When contributing to linkstatus, we ask that you:
 # Setting up the environment
 
 Below is the steps for setting up a development environment
-```
+```shell
 git clone https://github.com/pythonpune/linkstatus
 cd linkstatus
 virtualenv .venv
 source .venv/bin/activate
-pip install -e .
+python -m pip install -Ur dev-requirements.txt
+python -m pip install -e .
 linkstatus --help
 ```
 
+# Run unit test with nox
+```shell
+nox --list          # list all available sessions
+nox -s pre_commit   # run pre-commit checks
+nox -s tests        # run unit tests
+```
 # Your First Contribution
 
 - Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:

README.md

@@ -39,9 +39,27 @@ Options:
   -t, --timeout INTEGER  Request timeout (default 4 second)
   -rt, --retry INTEGER   Retry link status (default 2 time)
   --help                 Show this message and exit.
-```
 
-![linkstatus](https://user-images.githubusercontent.com/11618054/67764478-0fcec100-fa70-11e9-9c3c-04c1f432f620.png)
+
+❯❯❯ linkstatus tests/data/markdown_file.md
+Links in File: 'tests/data/markdown_file.md'
+✓ L4 : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+✓ L8 : http://www.google.com
+✓ L10 : https://www.google.com
+✓ L12 : https://github.com/pythonpune/linkstatus
+✓ L24 : http://www.example.com
+✗ L34 : https://github.com/pythonpune/linkcheck (404)
+✓ L39 : https://github.com//pythonpune/
+… L41 : http://<hostname>:<port> (skip)
+… L43 : https://<hostname>:<port>/pages (skip)
+=================================================================================================================
+                                                               Links Status Summary
+                                                                   Links UP: 6
+                                                                  Links SKIP: 2
+                                                                  Links DOWN: 1
+Warning: Use `noqa` inline comment to skip link check. like, response code 403 due to header restrictions etc...
+=================================================================================================================
+```
 
 
 **Note: Skip link check for any line by adding `noqa` (no quality assurance) as inline comment

dev-requirements.txt

@@ -1,3 +1,4 @@
+nox
 pre-commit
 pytest
 ruamel.yaml

noxfile.py

@@ -2,7 +2,12 @@
 
 
 @nox.session
-def run_tests(session):
-    session.install("-r", "dev-requirements.txt")
-    session.install("-e", ".")
-    session.run("pytest", "tests")
+def pre_commit(session):
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "-a")
+
+
+@nox.session(python=["3.6", "3.7"])
+def tests(session):
+    session.install("pytest", "ruamel.yaml", ".")
+    session.run("pytest", "-sqvv", "tests")