🐞 fix: best practice of tox

Author: aaron-yang-biz

docs/tutorial.md

@@ -151,7 +151,7 @@ This will give you a test report and a lint report. You should see no errors exc
 ## Step 6: Create GitHub Repo
 
 ???+Info
-    Going through step 6 and 7 is tedious. So that's why we provide a bash script --repo.sh, to help creating repo, setting secrets and publishing your code to the repo automatically.
+    Going through step 6 and 7 is tedious. So that's why we provide a bash script --github.sh, to help creating repo, setting secrets and publishing your code to the repo automatically.
 
     The script looks like the following:
     ```

pyproject.toml

@@ -1,7 +1,7 @@
 [tool]
 [tool.poetry]
 name = "ppw"
-version = "1.3.3"
+version = "1.3.4"
 description = "A Wizard to create a skeleton python project with up-to-date technology"
 license = "BSD-3-Clause"
 authors = ["Aaron Yang <aaron_yang@jieyu.ai>"]

reload.sh

@@ -20,7 +20,7 @@ if [ $# == 1 ]; then
     rm -rf /tmp/$1
 fi
 
-rm -rf /tmp/ppwtest
+rm -rf /tmp/ppw
 
 echo "running ppw"
 ppw

{{cookiecutter.project_slug}}/.github/workflows/dev.yml

@@ -11,7 +11,6 @@ on:
   pull_request:
     branches:
       - '*'
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
@@ -33,6 +32,7 @@ jobs:
       package_name: ${{ steps.variables_step.outputs.package_name }}
       repo_name: ${{ steps.variables_step.outputs.repo_name }}
       repo_owner: ${{ steps.variables_step.outputs.repo_owner }}
+      build_number: ${{ steps.variables_step.outputs.build_number }}
 
     # uncomment the following to pickup services
     # services:
@@ -133,7 +133,7 @@ jobs:
           password: ${{ secrets.BUILD_NOTIFY_MAIL_PASSWORD }}
           from: build-bot
           to: ${{ secrets.BUILD_NOTIFY_MAIL_RCPT }}
-          subject: ${{ needs.test.outputs.package_name }}.${{ needs.test.outputs.package_version}}.${{ github.run_number }} build successfully
+          subject: ${{ needs.test.outputs.package_name }}.${{ needs.test.outputs.package_version}}.dev.${{ github.run_number }} build successfully
           convert_markdown: true
           html_body: |
             ## Build Success
@@ -178,8 +178,8 @@ jobs:
       #     title: CI Notification | Success
       #     text: |
       #       ### Build Success
-      #       ${{ needs.test.outputs.package_version }}.dev.${{ github.run_number }} is built and published to test pypi
+      #       ${{ needs.test.outputs.package_version }}.dev.${{ github.run_number }}published to TEST pypi
       #       ### Change History
       #       Please check change history at https://${{ needs.test.outputs.repo_owner }}.github.io/${{ needs.test.outputs.repo_name }}/${{ needs.test.outputs.package_version }}.dev/history
       #       ### Package Download
-      #       Please download the pacakge at: https://test.pypi.org/project/${{ needs.test.outputs.repo_name }}/
+      #       The pacakge is availabled at: https://test.pypi.org/project/${{ needs.test.outputs.repo_name }}/

{{cookiecutter.project_slug}}/.github/workflows/release.yml

@@ -65,7 +65,7 @@ jobs:
           poetry run mkdocs build
           git config --global user.name Docs deploy
           git config --global user.email docs@dummy.bot.com
-          poetry run mike deploy -p -f --ignore `poetry version --short`
+          poetry run mike deploy -p -f --ignore `poetry version --short` latest
           poetry run mike set-default -p `poetry version --short`
 
       - name: Build wheels and source tarball
@@ -114,7 +114,7 @@ jobs:
           convert_markdown: true
           html_body: |
             ## Build Success
-            ${{ needs.release.outputs.package_name }}.${{ needs.release.outputs.package_version }} is built and published to PYPI
+            ${{ needs.release.outputs.package_name }}.${{ needs.release.outputs.package_version }} has been published to PYPI
 
             ## Change Details
             ${{ github.event.head_commit.message }}
@@ -157,9 +157,9 @@ jobs:
       #     msgtype: markdown
       #     title: CI Notification | Success
       #     text: |
-      #       ### Build Success
-      #       ${{ needs.release.outputs.package_version_full }} is built and published to test pypi
+      #       ### ${{ needs.release.outputs.package_name }} Build Success
+      #       ${{ needs.release.outputs.package_version }} has been published to PYPI
       #       ### Change History
-      #       Please check change history at https://${{ needs.release.outputs.repo_owner }}.github.io/${{ needs.release.outputs.repo_name }}/history
+      #       Please check change history at https://${{ needs.release.outputs.repo_owner }}.github.io/${{ needs.release.outputs.repo_name }}/latest/history
       #       ### Package Download
-      #       Please download the pacakge at: https://test.pypi.org/project/${{ needs.release.outputs.repo_name }}/
+      #       Please download the pacakge at: https://pypi.org/project/${{ needs.release.outputs.repo_name }}/

{{cookiecutter.project_slug}}/repo.sh {{cookiecutter.project_slug}}/github.sh{{cookiecutter.project_slug}}/repo.sh renamed to {{cookiecutter.project_slug}}/github.sh

@@ -10,23 +10,27 @@ python =
     3.7: py37
 
 [testenv:lint]
+extras =
+    dev
+    doc
+deps =
+    poetry
 commands =
-    poetry install -E dev -E doc
-    isort {{ cookiecutter.project_slug }}
-    black {{ cookiecutter.project_slug }} tests
-    flake8 {{ cookiecutter.project_slug }} tests
+    poetry run isort {{ cookiecutter.project_slug }}
+    poetry run black {{ cookiecutter.project_slug }} tests
+    poetry run flake8 {{ cookiecutter.project_slug }}
     poetry build
-    mkdocs build
-    twine check dist/*
+    poetry run mkdocs build
+    poetry run twine check dist/*
 
 [testenv]
-skip_install = true
 passenv = *
 setenv =
     PYTHONPATH = {toxinidir}
     PYTHONWARNINGS = ignore
 deps = 
     poetry
+extras =
+    test
 commands =
-    poetry install -E test
     poetry run pytest -s --cov={{ cookiecutter.project_slug }} --cov-append --cov-report=xml --cov-report term-missing tests