Skip to content

Commit 65f0d82

Browse files
committed
Quality improvement: documentation, code style, lint, coverage
Refractor Object decoder
1 parent 978be0c commit 65f0d82

27 files changed

Lines changed: 290 additions & 239 deletions

Makefile

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Automate pip package development
22
#
3+
# Usage
4+
# To release a package.
5+
# - update version in serpapi/_version.py
6+
# - review README version
7+
# - run
8+
# $ make release
9+
310
# current version
411
version=$(shell grep version setup.py | cut -d"'" -f2)
512
dist=dist/serpapi-$(version).tar.gz
@@ -21,12 +28,17 @@ lint:
2128
test:
2229
pytest --cov=serpapi --cov-report html tests/*.py
2330

31+
# install dependencies
32+
#
2433
# pytest-cov - code coverage extension for pytest
2534
# sphinx - documentation
35+
# twine - release automation
2636
install:
2737
pip3 install -U setuptools
2838
pip3 install -r requirements.txt
39+
pip3 install pylint
2940
pip3 install pytest-cov
41+
pip3 install twine
3042
pip3 install sphinx
3143

3244
readme:
@@ -36,14 +48,15 @@ doc: readme
3648
$(MAKE) -C docs/ html
3749

3850
# https://packaging.python.org/tutorials/packaging-projects/
39-
build: doc test
51+
build: doc lint test
4052
python3 setup.py sdist
4153

4254
# out of box testing / user acceptance before delivery
4355
oobt: build
4456
pip3 install ./${dist}
4557
python3 oobt/oobt.py
4658

59+
4760
check: oobt
4861
twine check ${dist}
4962

0 commit comments

Comments
 (0)