chore: update makefile and others

Author: sean2077

.gitignore

@@ -1,3 +1,7 @@
+.vscode/
+.idea/
+
+### Python template
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -20,7 +24,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -50,6 +53,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -72,6 +76,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -82,7 +87,9 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -127,6 +134,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-.vscode
 
-tmp.py
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

Makefile

@@ -1,24 +1,58 @@
-.PHONY: test install
+# project metadata
+NAME := `python setup.py --name`
+FULLNAME := `python setup.py --fullname`
+VERSION := `python setup.py --version`
+BUILD := `git rev-parse --short HEAD`
 
-install:
-	pip install . --no-index
+.PHONY: info help clean dist docs
+.DEFAULT_GOAL := help
 
-uninstall:
-	pip uninstall jsonpath
+define PRINT_HELP_PYSCRIPT
+import re, sys
 
-test:
-	pytest test -vv -s
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
 
+info: ## project info
+	@echo $(FULLNAME) at $(BUILD)
 
-PYCACHE_DIR := $(shell find . -name '__pycache__' -type d)
-PYTEST_DIR := $(shell find . -name '.pytest_cache' -type d)
-EGG_DIR := $(shell find . -name '*.egg-info' -type d)
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean:
-	rm -rf $(PYCACHE_DIR) ${PYTEST_DIR} ${EGG_DIR} dist
+clean: clean-build clean-pyc ## remove all build, test, coverage and Python artifacts
 
-package: clean
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+lint: ## check style with black
+	find $(NAME) -name '*.py' -type f -not -path "*/pb/*" -not -path "*/data/*" -exec black {} +
+
+docs: ## format docs
+	doctoc --gitlab README.md
+
+install: ## install the package to the active Python's site-packages
+	pip install . -U --no-index
+
+uninstall: ## uninstall the package
+	pip uninstall $(NAME)
+
+dist: clean ## package
 	python3 setup.py sdist bdist_wheel
 
-upload: package
+upload: dist # upload the package to pypi
 	twine upload dist/*

jsonpath/__init__.py

@@ -2,7 +2,7 @@
 Author       : zhangxianbing
 Date         : 2020-12-27 09:22:14
 LastEditors  : zhangxianbing
-LastEditTime : 2021-03-02 20:01:19
+LastEditTime : 2021-06-04 09:07:14
 Description  : JSONPath
 """
 __version__ = "1.0.5"
@@ -16,8 +16,6 @@
 from collections import defaultdict
 from typing import Union
 
-# pylint: disable=invalid-name,missing-function-docstring,missing-class-docstring,eval-used,logging-fstring-interpolation
-
 
 def create_logger(name: str = None, level: Union[int, str] = logging.INFO):
     """Get or create a logger used for local debug."""

setup.py

@@ -14,9 +14,10 @@
     url="https://github.com/zhangxianbing/jsonpath-python",
     packages=find_packages(include=["jsonpath*"]),
     classifiers=[
-        "Programming Language :: Python :: 3.6",
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.6",
     ],
     python_requires=">=3.6",
 )