Merge pull request #6 from ma7555/fix_some_bugs

Author: aaron

docs/tutorial.md

@@ -90,6 +90,7 @@ though.
 ```
 conda create -n mypackage python=3.8
 conda activate mypackage
+conda install -c conda-forge tox-conda
 ```
 
 You could choose your favorite python version here. 

mkdocs.yml

@@ -8,13 +8,22 @@ nav:
   - Release checklist: pypi_release_checklist.md
   - FAQ: faq.md
   - History: history.md
-  
+
 theme:
   name: material
   language: en
   #logo: assets/logo.png
   palette:
-    primary: light blue
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
   features:
     - navigation.indexes
     - navigation.tabs

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

@@ -2,13 +2,13 @@
 
 name: dev workflow
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [ master,main,release ]
+    branches: [master, main, release]
   pull_request:
-    branches: [ master,main,release ]
+    branches: [master, main, release]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -20,8 +20,8 @@ jobs:
     # The type of runner that the job will run on
     strategy:
       matrix:
-        python-versions: [3.6, 3.7, 3.8, 3.9]
-        os: [ubuntu-18.04, macos-latest, windows-latest]
+        python-versions: ["3.7", "3.8", "3.9", "3.10"]
+        os: [ubuntu-20.04, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
@@ -38,8 +38,7 @@ jobs:
           pip install poetry tox tox-gh-actions
 
       - name: test with tox
-        run:
-          tox
+        run: tox
 
       - name: list files
         run: ls -l .
@@ -60,13 +59,12 @@ jobs:
           pip install poetry tox tox-gh-actions
 
       - name: test with tox
-        run:
-          tox
+        run: tox
 
       - name: list files
         run: ls -l .
 
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v2
         with:
           fail_ci_if_error: true
           files: coverage.xml

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

@@ -6,9 +6,8 @@ name: release & publish workflow
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branch: release
     tags:
-      - 'v*'
+      - "v*.*.*"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -22,29 +21,21 @@ jobs:
 
     strategy:
       matrix:
-        python-versions: [3.8]
+        python-versions: [3.9]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
-
-      - name: generate change log
-        uses: heinrichreimer/github-changelog-generator-action@v2.1.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          issues: true
-          issuesWoLabels: true
-          pullRequests: true
-          prWoLabels: true
-          unreleased: true
-          addSections: '{"documentation":{"prefix":"**Documentation:**","labels":["documentation"]}}'
-          output: CHANGELOG.md
-
+      - name: Checks-out
+        uses: actions/checkout@v2
+      - name: "Build Changelog"
+        id: build_changelog
+        uses: mikepenz/release-changelog-builder-action@v2.9.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-versions }}
-
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -80,9 +71,9 @@ jobs:
           draft: false
           prerelease: false
 
-      - name:
+      - name: create pypi release
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
-          skip_existing: true
+          skip_existing: true

{{cookiecutter.project_slug}}/.isort.cfg

@@ -1,9 +1,4 @@
 [settings]
-multi_line_output = 3
-include_trailing_comma = True
-force_grid_wrap = 0
-use_parentheses = True
-ensure_newline_before_comments = True
-line_length = 88
+profile=black
 # you can skip files as below
 #skip_glob = docs/conf.py

{{cookiecutter.project_slug}}/CONTRIBUTING.md

@@ -126,4 +126,4 @@ $ git push
 $ git push --tags
 ```
 
-Travis will then deploy to PyPI if tests pass.
+Github Actions will then deploy to PyPI if tests pass.

{{cookiecutter.project_slug}}/README.md

@@ -12,8 +12,8 @@
     <img src="https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/main.yml/badge.svg?branch=release" alt="CI Status">
 </a>
 
-<a href="https://{{ cookiecutter.project_slug | replace("_", "-") }}.readthedocs.io/en/latest/?badge=latest">
-    <img src="https://readthedocs.org/projects/{{ cookiecutter.project_slug | replace("_", "-") }}/badge/?version=latest" alt="Documentation Status">
+<a href="https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}/">
+    <img src="https://img.shields.io/website/https/{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}/index.html.svg?label=docs&down_message=unavailable&up_message=available" alt="Documentation Status">
 </a>
 {% if cookiecutter.add_pyup_badge == 'y' %}
 <a href="https://pyup.io/repos/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/">
@@ -35,7 +35,7 @@
 
 {% if is_open_source %}
 * Free software: {{ cookiecutter.open_source_license }}
-* Documentation: <https://{{ cookiecutter.project_slug | replace("_", "-") }}.readthedocs.io>
+* Documentation: <https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}/>
 {% endif %}
 
 ## Features

{{cookiecutter.project_slug}}/docs/installation.md

@@ -6,7 +6,7 @@ To install {{ cookiecutter.project_name }}, run this command in your
 terminal:
 
 ``` console
-$ pip install {{ cookiecutter.project_slug }}
+pip install {{ cookiecutter.project_slug }}
 ```
 
 This is the preferred method to install {{ cookiecutter.project_name
@@ -23,19 +23,19 @@ the [Github repo][].
 You can either clone the public repository:
 
 ``` console
-$ git clone git://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
+git clone git://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
 ```
 
 Or download the [tarball][]:
 
 ``` console
-$ curl -OJL https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/tarball/master
+curl -OJL https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/tarball/master
 ```
 
 Once you have a copy of the source, you can install it with:
 
 ``` console
-$ pip install .
+pip install .
 ```
 
   [pip]: https://pip.pypa.io

{{cookiecutter.project_slug}}/mkdocs.yml

@@ -17,7 +17,16 @@ theme:
   language: en
   #logo: assets/logo.png
   palette:
-    primary: light blue
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
   features:
     - navigation.indexes
     - navigation.tabs

{{cookiecutter.project_slug}}/pyproject.toml

@@ -24,40 +24,42 @@ classifiers=[
 {%- endif %}
     'Natural Language :: English',
     'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.6',
     'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
 ]
 packages = [
     { include = "{{ cookiecutter.project_slug }}" },
     { include = "tests", format = "sdist" },
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.6.1,<4.0"
+python = ">=3.7.1,<4.0"
 {%- if cookiecutter.command_line_interface|lower == 'fire' %}
 fire = "0.4.0"
 {%- endif %}
 
-black  = { version = "20.8b1", optional = true}
-isort  = { version = "5.6.4", optional = true}
-flake8  = { version = "3.8.4", optional = true}
+black  = { version = "22.1.0", optional = true}
+isort  = { version = "5.10.1", optional = true}
+flake8  = { version = "4.0.1", optional = true}
 flake8-docstrings = { version = "^1.6.0", optional = true }
-pytest  = { version = "6.1.2", optional = true}
-pytest-cov  = { version = "2.10.1", optional = true}
-tox  = { version = "^3.20.1", optional = true}
-virtualenv  = { version = "^20.2.2", optional = true}
-pip  = { version = "^20.3.1", optional = true}
-mkdocs  = { version = "^1.1.2", optional = true}
-mkdocs-include-markdown-plugin  = { version = "^1.0.0", optional = true}
-mkdocs-material  = { version = "^6.1.7", optional = true}
-mkdocstrings  = { version = "^0.13.6", optional = true}
-mkdocs-material-extensions  = { version = "^1.0.1", optional = true}
-twine  = { version = "^3.3.0", optional = true}
-mkdocs-autorefs = {version = "0.1.1", optional = true}
-pre-commit = {version = "^2.12.0", optional = true}
+pytest  = { version = "^7.0.1", optional = true}
+pytest-cov  = { version = "^3.0.0", optional = true}
+tox  = { version = "^3.24.5", optional = true}
+virtualenv  = { version = "^20.13.1", optional = true}
+pip  = { version = "^22.0.3", optional = true}
+mkdocs  = { version = "^1.2.3", optional = true}
+mkdocs-include-markdown-plugin  = { version = "^3.2.3", optional = true}
+mkdocs-material  = { version = "^8.1.11", optional = true}
+mkdocstrings  = { version = "^0.18.0", optional = true}
+mkdocs-material-extensions  = { version = "^1.0.3", optional = true}
+twine  = { version = "^3.8.0", optional = true}
+mkdocs-autorefs = {version = "^0.3.1", optional = true}
+pre-commit = {version = "^2.17.0", optional = true}
 toml = {version = "^0.10.2", optional = true}
+livereload = {version = "^2.6.3", optional = true}
+pyreadline = {version = "^2.1", optional = true}
 
 [tool.poetry.extras]
 test = [
@@ -106,3 +108,5 @@ exclude = '''
   | dist
 )/
 '''
+[tool.isort]
+profile = "black"