Update readme and format code (#17)

* Format README.rst

* Update with running pre-commit

* Autoupdate pre-commit

* Remove reorder_python_imports hook

* Format yaml files

Author: shenxianpeng

.github/workflows/python-publish.yml

@@ -49,4 +49,3 @@ jobs:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: twine upload dist/*
-      

.github/workflows/python-test.yml

@@ -46,7 +46,7 @@ jobs:
 
       - name: build wheel
         run: python -m pip wheel -w dist .
-      
+
       - name: upload wheel as artifact
         uses: actions/upload-artifact@v3
         with:

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 1f6de3d70391131fac4b911ae913c568e571e34e
+    rev: v4.3.0
     hooks:
       - id: trailing-whitespace
         exclude: \.output
@@ -11,17 +11,12 @@ repos:
       - id: check-yaml
       - id: debug-statements
       - id: requirements-txt-fixer
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.7.0
-    hooks:
-      - id: reorder-python-imports
-        language_version: python3
   - repo: https://github.com/asottile/pyupgrade
-    rev: v1.16.1
+    rev: v2.37.3
     hooks:
       - id: pyupgrade
   - repo: https://github.com/pycqa/flake8
-    rev: '4.0.1'
+    rev: '5.0.4'
     hooks:
       - id: flake8
         args: [--max-line-length=120]

README.rst

@@ -11,9 +11,10 @@ clang-tools Introduction
     :target: https://codecov.io/gh/cpp-linter/clang-tools-pip
     :alt: codecov
 .. image:: https://img.shields.io/badge/platform-linux--64%20%7C%20win--64%20%7C%20osx--64%20-blue
-    :target: https://pypi.org/project/clang-tools/)
+    :target: https://pypi.org/project/clang-tools/
     :alt: Platfrom
 .. image:: https://img.shields.io/pypi/dw/clang-tools
+    :target: https://pypistats.org/packages/clang-tools
     :alt: PyPI - Downloads
 
 
@@ -37,7 +38,7 @@ Install
         ./env-name/Scripts/activate
 
     This will ensure that
-    
+
     1. there are no permission problems when installing the tool
     2. the installed path (for MacOS and Windows) is within the environment's
        variable ``PATH``.
@@ -62,13 +63,12 @@ Usage
     usage: clang-tools [-h] [-i INSTALL] [-d DIRECTORY] [-f]
 
     optional arguments:
-    -h, --help            show this help message and exit
-    -i INSTALL, --install INSTALL
+      -h, --help            show this help message and exit
+      -i INSTALL, --install INSTALL
                             Install clang-tools with specific version. default is 13.
-    -d DIRECTORY, --directory DIRECTORY
+      -d DIRECTORY, --directory DIRECTORY
                             The directory where is the clang-tools install.
-    -f                    Force overwriting the symlink to the installed binary. This will only overwrite an existing
-                            symlink.
+      -f                    Force overwriting the symlink to the installed binary. This will only overwrite an existing symlink.
 
 Use ``clang-tools`` command to install version 13 binaries.