add and run precommit to format codes (#24)

* add pre-commit config

* run pre-commit

Author: njzjz

.github/workflows/python-publish.yml

@@ -7,7 +7,7 @@ on:
   release:
     types: [published]
   workflow_dispatch:
-    
+
 
 
 jobs:

.gitignore

@@ -53,4 +53,4 @@ env/
 venv/
 ENV/
 env.bak/
-venv.bak/
+venv.bak/

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-json
+    -   id: check-added-large-files
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-toml
+# Python
+-   repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+    -   id: black-jupyter

README.md

@@ -1,21 +1,21 @@
 # Argument checking for python programs
 
-This is a minimum version for checking the input argument dict. 
-It would examine argument's type,  as well as keys and types of its sub-arguments. 
+This is a minimum version for checking the input argument dict.
+It would examine argument's type,  as well as keys and types of its sub-arguments.
 
-A special case called *variant* is also handled, 
-where you can determine the items of a dict based the value of on one of its `flag_name` key. 
+A special case called *variant* is also handled,
+where you can determine the items of a dict based the value of on one of its `flag_name` key.
 
 There are three main methods of `Argument` class:
 
 - `check` method that takes a dict and see if its type follows the definition in the class
 - `normalize` method that takes a dict and convert alias and add default value into it
 - `gendoc` method that outputs the defined argument structure and corresponding docs
 
-There are also `check_value` and `normalize_value` that 
+There are also `check_value` and `normalize_value` that
 ignore the leading key comparing to the base version.
 
-When targeting to html rendering, additional anchor can be made for cross reference. 
+When targeting to html rendering, additional anchor can be made for cross reference.
 Set `make_anchor=True` when calling `gendoc` function and use standard ref syntax in rst.
 The id is the same as the argument path. Variant types would be in square brackets.
 

dargs/__init__.py

@@ -1,3 +1,3 @@
 from .dargs import Argument, Variant, ArgumentEncoder
 
-__all__ = ["Argument", "Variant", "ArgumentEncoder"]
+__all__ = ["Argument", "Variant", "ArgumentEncoder"]