🐞 fix: init git failed with --global

1. init git may fail due to specified with --global option, now replaced by --system
2. remove ppw's author info from cookiecutter.json
3. add .history to .gitignore
4. update python to >=3.7,<4.0
5. rename project as python-project-wizard

Author: aaron-yang-biz

.github/workflows/dev.yml

@@ -2,7 +2,7 @@
 
 name: dev CI 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:

.gitignore

@@ -101,4 +101,5 @@ cookiecutter-pypackage-env/
 .vscode/
 
 # mkdocs
-site/
+site/
+.history/

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+-   repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.1.13
+    hooks:
+    -   id: forbid-crlf
+    -   id: remove-crlf
+    -   id: forbid-tabs
+    -   id: remove-tabs
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-merge-conflict
+    - id: check-yaml
+      args: [--unsafe]
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    - id: isort
+-   repo: https://github.com/ambv/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+      language_version: python3.8
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-typing-imports==1.10.0]

CONTRIBUTING.rst

@@ -233,4 +233,3 @@ To write and run your new test, follow these steps:
 .. cookiecutter: https://github.com/audreyr/cookiecutter-pypackage
 .. virtualenv: https://virtualenv.pypa.io/en/stable/installation
 .. git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
-

README.md

@@ -1,10 +1,10 @@
 # Python Project Wizard
 
-A tool for creating skeleton python project, built with popular develop tools and 
+A tool for creating skeleton python project, built with popular develop tools and
 conform to best practice.
 
 [![Version](http://img.shields.io/pypi/v/ppw?color=brightgreen)](https://pypi.python.org/pypi/ppw)
-[![CI Status](https://github.com/zillionare/cookiecutter-pypackage/actions/workflows/release.yml/badge.svg)](https://github.com/zillionare/cookiecutter-pypackage)
+[![CI Status](https://github.com/zillionare/python-project-wizard/actions/workflows/release.yml/badge.svg)](https://github.com/zillionare/python-project-wizard)
 [![Dowloads](https://img.shields.io/pypi/dm/ppw)](https://pypi.org/project/ppw/)
 [![License](https://img.shields.io/pypi/l/ppw)](https://opensource.org/licenses/BSD-2-Clause)
 ![Python Versions](https://img.shields.io/pypi/pyversions/ppw)
@@ -44,7 +44,7 @@ Generate a Python package project by simple run:
   ppw
 ```
 
-Then follow **[Tutorial](https://zillionare.github.io/cookiecutter-pypackage/tutorial/)** to finish other configurations.
+Then follow **[Tutorial](https://zillionare.github.io/python-project-wizard/tutorial/)** to finish other configurations.
 
 # Credits
 
@@ -65,3 +65,7 @@ This repo is forked from [audreyr/cookiecutter-pypackage](https://github.com/aud
 [github actions]: https://github.com/features/actions
 [Git Pages]: https://pages.github.com
 [Pre-commit hooks]: https://pre-commit.com/
+
+# More projects by same author
+## cfg4py
+[cfg4py](https://pypi.org/project/cfg4py/) is a great tool for managing configuration files, supporting configuration for different environments (dev, prodction and test), automatically converting yaml-based configuration to python class, so you can access configuration items by attribute, thus enable auto-completion (by IDE). It also support live-reload, remote central configuration, config template and more.

cookiecutter.json

@@ -1,7 +1,7 @@
 {
-  "full_name": "Aaron Yang",
-  "email": "code@jieyu.ai",
-  "github_username": "zillionare",
+  "full_name": "",
+  "email": "",
+  "github_username": "",
   "project_name": "Python Boilerplate",
   "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
   "project_short_description": "Skeleton project created by Python Project Wizard (ppw)",

docs/faq.md

@@ -19,7 +19,7 @@
           #sinceTag: v0.1.1
           output: CHANGELOG.md
     ```
-    uncomment `#sinceTag` line and given an existed tag name in your project. If 
+    uncomment `#sinceTag` line and given an existed tag name in your project. If
     there's none, you have to create one now.
 
 ???+ Question
@@ -35,51 +35,51 @@
 
 ???+ Question
     # Why mkdocs over sphinx?
-    reStructured Text and Sphinx is way to tedious, though powerful. With extension, 
-    you'll find almost all features are available in mkdocs, in a neat and productive 
+    reStructured Text and Sphinx is way to tedious, though powerful. With extension,
+    you'll find almost all features are available in mkdocs, in a neat and productive
     way. Poetry and Markdown, are the two key factors driven me develop this template.
 
 ???+ Question
     # What are the configuration items?
-    
+
     Here is a list:
 
     ```
     ## Templated Values
 
     The following appear in various parts of your generated project.
 
-    full_name  
+    full_name
     Your full name.
 
-    email  
+    email
     Your email address.
 
-    github_username  
+    github_username
     Your GitHub username.
 
-    project_name  
+    project_name
     The name of your new Python package project. This is used in
     documentation, so spaces and any characters are fine here.
 
-    project_slug  
+    project_slug
     The namespace of your Python package. This should be Python
     import-friendly. Typically, it is the slugified version of
     project_name.
 
-    project_short_description  
+    project_short_description
     A 1-sentence description of what your Python package does.
 
-    release_date  
+    release_date
     The date of the first release.
 
-    pypi_username  
+    pypi_username
     Your Python Package Index account username.
 
-    year  
+    year
     The year of the initial package copyright in the license file.
 
-    version  
+    version
     The starting version number of the package.
 
     install_precommit_hooks
@@ -93,7 +93,7 @@
     The following package configuration options set up different features
     for your project.
 
-    command_line_interface  
+    command_line_interface
     Whether to create a console script using Python Fire. Console script
     entry point will match the project_slug. Options: \['fire', "No
     command-line interface"\]
@@ -105,3 +105,12 @@
     - PERSONAL_TOKEN (required for publishing document to git pages)
     - TEST_PYPI_API_TOKEN (required for publishing dev release to testpypi)
     - PYPI_API_TOKEN (required for publish )
+
+???+ Question
+    # first launch of pre-commit failed
+
+    first time launch `pre-commit run` failed with error: "[WARNING] The 'rev' field of
+    repo 'https://github.com/ambv/black' appears to be a mutable reference
+    (moving tag / branch)"
+
+    Please follow the instructions to update pre-commit then run again.

docs/history.md

@@ -32,4 +32,3 @@
 [github actions]: https://github.com/features/actions
 [Git Pages]: https://pages.github.com
 [Pre-commit hooks]: https://pre-commit.com/
-

docs/index.md

@@ -1,3 +1,3 @@
 {%
     include-markdown "../README.md"
-%}
+%}

docs/tutorial.md

@@ -3,9 +3,9 @@
 ??? Note
     Did you find this article confusing? [Edit this file] and pull a request!
 
-To start with, you will need [GitHub], [Pypi] , [TestPyPi] and [Codecov] account. If 
-you don't have one, please follow the links to apply one before you get started on this 
-tutorial. 
+To start with, you will need [GitHub], [Pypi] , [TestPyPi] and [Codecov] account. If
+you don't have one, please follow the links to apply one before you get started on this
+tutorial.
 
 If you are new to Git and GitHub, you should probably spend a few minutes on
 some of the tutorials at the top of the page at [GitHub Help]
@@ -81,10 +81,10 @@ Also be noticed that there's pyproject.toml in this folder. This is the main
 configuration file of our project.
 
 ## Step 3: Build a virtual environment for your development
-Now build a virtual python environment for your development, and develop your project 
+Now build a virtual python environment for your development, and develop your project
 always in that environment from now on.
 
-You can choose either annaconda or virtualenv. I prefer annaconda (actually miniconda) 
+You can choose either annaconda or virtualenv. I prefer annaconda (actually miniconda)
 though.
 
 ```
@@ -93,7 +93,7 @@ conda activate mypackage
 conda install -c conda-forge tox-conda
 ```
 
-You could choose your favorite python version here. 
+You could choose your favorite python version here.
 ## Step 4: Install Dev Requirements
 
 You should still be in the folder named as `%proejct_slug`, which containing the
@@ -109,16 +109,16 @@ tox
 ```
 
 We start with install poetry, since the whole project is managed by poetry. Then we
-installed extra dependency need by developer, such as documentation build tools, lint, 
+installed extra dependency need by developer, such as documentation build tools, lint,
 formatting and test tools etc.
 
 We also launch a smoke test here by running `tox`. This will give you a test report and
  lint report. You should see no errors except some lint warnings.
 
 ??? Tips
 
-    Extra dependencies are grouped into three groups, doc, dev and test for better 
-    granularity. When you ship the package, dependencies in group doc, dev and test 
+    Extra dependencies are grouped into three groups, doc, dev and test for better
+    granularity. When you ship the package, dependencies in group doc, dev and test
     might not be shipped.
 
     As the developer, you will need install all the dependencies.
@@ -151,7 +151,7 @@ Then goto repo > settings > secrets, click on 'New repository secret', add the f
 
 ???+ Tips
 
-    If you have already setup codecov integration and configured access for all your 
+    If you have already setup codecov integration and configured access for all your
     repositories, you can skip this step.
 
 In your browser, visit [install codecov app], you'll be landed at this page:
@@ -163,7 +163,7 @@ on `install` button, following directions until all set.
 
 ## Step 7: Upload code to github
 
-Back to your develop environment, find the folder named after the `[project_slug]`. 
+Back to your develop environment, find the folder named after the `[project_slug]`.
 Move into this folder, and then setup git to use your GitHub repo and upload the
 code:
 
@@ -185,7 +185,7 @@ You'll need a ssh key to push the repo. You can [Generate] a key or
 
 ???+ Warning
 
-    if you answered 'yes' to the question if install pre-commit hooks at last step, 
+    if you answered 'yes' to the question if install pre-commit hooks at last step,
     then you should find pre-commit be invoked when you run `git commit`, and some files
      may be modified by hooks. If so, please add these files and **commit again**.
 
@@ -201,7 +201,7 @@ new artifact is published under the name {{ cookiecutter.project_slug }}
 
 ## Step 8. Check documentation
 
-  Documentation will be published and available at 
+  Documentation will be published and available at
   <https://{your_github_account}.github.io/{your_repo}> once:
 
     1. the branch is release
@@ -218,7 +218,7 @@ new artifact is published under the name {{ cookiecutter.project_slug }}
 
 ## Step 9. Make official release
 
-  After done with your phased development, switch to releas branch, following 
+  After done with your phased development, switch to releas branch, following
   instructions at [release checklist](/pypi_release_checklist), trigger first official release and check
   result at [PYPI].