added improvements to noxfile workflow

Author: nullhack

cookiecutter.json

@@ -2,7 +2,7 @@
   "full_name": "Eric Lopes",
   "email": "[email protected]",
   "github_username": "nullhack",
-  "project_name": "My Python Project",
+  "project_name": "Python Base Project",
   "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
   "package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_').replace('project', 'package') }}",
   "module_name": "{{ cookiecutter.package_name.lower().replace(' ', '_').replace('-', '_').replace('package', 'module') }}",

{{cookiecutter.project_slug}}/.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = E203, E266, E501, W503
+ignore = E203, E266, E501, W503, T499
 max-line-length = 79
 enable-extensions=G
 #select = B,C,E,F,W,T4,T0,N8,DC,DAR,SCS

{{cookiecutter.project_slug}}/.gitignore

@@ -6,6 +6,10 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# Remove tests and coverage reports
+docs/cov-report
+docs/pytest_report.html
+
 # C extensions
 *.so
 

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -3,6 +3,7 @@ repos:
     rev: v4.1.0
     hooks:
     -   id: trailing-whitespace
+        files: .*\.py
     -   id: check-yaml
     -   id: check-added-large-files
     -   id: check-ast
@@ -24,7 +25,7 @@ repos:
     hooks:
     -   id: black-formatter
         name: black-formatter
-        stages: [commit]
+        stages: [commit, push]
         language: system
         entry: nox -s black
         types: [python]
@@ -33,33 +34,33 @@ repos:
     hooks:
     -   id: flake8-lint
         name: flake8-lint
-        stages: [commit]
+        stages: [commit, push]
         language: system
         entry: nox -s lint
         types: [python]
         pass_filenames: false
 -   repo: local
     hooks:
-    -   id: pytest-cov
-        name: pytest-cov
+    -   id: pytest
+        name: pytest
         stages: [commit]
         language: system
         entry: nox -s tests
         types: [python]
         pass_filenames: false
 -   repo: local
     hooks:
-    -   id: test-docs
-        name: test-docs
+    -   id: pytest-docs
+        name: pytest-docs
         stages: [push]
         language: system
         entry: nox -s test-docs
         types: [python]
         pass_filenames: false
 -   repo: local
     hooks:
-    -   id: documentation
-        name: documentation
+    -   id: api-documentation
+        name: api-documentation
         stages: [push]
         language: system
         entry: nox -s api-docs
@@ -69,7 +70,7 @@ repos:
     hooks:
     -   id: uml-diagram
         name: uml-diagram
-        stages: [commit]
+        stages: [push]
         language: system
         entry: nox -s uml
         types: [python]

{{cookiecutter.project_slug}}/README.md

@@ -28,10 +28,6 @@
     <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/api/{{cookiecutter.project_slug}}/index.html"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/pytest_report.html">Tests</a>
-    ·
-    <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/cov-report/index.html">Code Coverage</a>
-    ·
     <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues">Report Bug</a>
     ·
     <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues">Request Feature</a>
@@ -80,15 +76,15 @@
   <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png">
     <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png" alt="uml-diagram-packages">
   </a>
-  
+
 ---
 
 #### Classes
 
   <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png">
     <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png" alt="uml-diagram-classes">
   </a>
-  
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- GETTING STARTED -->
@@ -101,9 +97,9 @@ To get a local copy up and running follow these simple steps.
 This Project depends on the following projects.
 * poetry
   ```sh
-  curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
+  pip install --user --upgrade poetry
   ```
-  
+
 * nox
   ```sh
   pip install --user --upgrade nox
@@ -116,11 +112,15 @@ This Project depends on the following projects.
    git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
    cd {{cookiecutter.project_slug}}
    ```
-2. Install Python packages
+2. Install nox
+   ```sh
+   pip install --user --upgrade nox
+   ```
+3.  Install pre-commit and poetry
    ```sh
-   poetry install
+   nox -s install
    ```
-3. Run tests
+4. Run tests
    ```sh
    nox -s tests
    ```
@@ -134,21 +134,26 @@ This Project depends on the following projects.
 
 Some useful examples of how this project can be used:
 
+*  Install and run pre-commit checks
+   ```sh
+   nox
+   ```
+
 *  Run tests
    ```sh
    nox -s tests
    ```
-   
+
 *  Run code lint
    ```sh
    nox -s lint
    ```
-   
+
 *  Generate API documentation
    ```sh
    nox -s api-docs
    ```
-   
+
 *  Run pre-commit checks
    ```sh
    nox -s pre-commit

{{cookiecutter.project_slug}}/docs/api/{{cookiecutter.project_slug}}/index.html

@@ -0,0 +1 @@
+*