Dev

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: serpapi-python
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: pytest
+      env:
+        API_KEY: ${{secrets.API_KEY}}

.gitignore

@@ -0,0 +1,11 @@
+script/
+.coverage
+docs/build
+dist/
+.pytest_cache/
+serpapi.egg-info/
+
+serpapi/__pycache__
+tests/__pycache__
+*.pyc
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2022 SerpApi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,69 @@
+# Automate pip package development
+#
+# Usage
+# To release a package.
+# - update version in serpapi/_version.py
+# - review README version
+# - run 
+# $ make release
+
+# current version
+version=$(shell grep version setup.py | cut -d"'" -f2)
+dist=dist/serpapi-$(version).tar.gz
+
+.PHONY: build
+
+all: clean install readme doc lint test build oobt check
+
+clean:
+	find . -name '*.pyc' -delete
+	find . -type d -name "__pycache__" -delete
+	python3 -m pip uninstall serpapi
+
+# lint check
+lint:
+	python3 -m pylint serpapi
+
+# test with Python 3
+test:
+	python3 -mpytest --cov=serpapi --cov-report html tests/*.py
+
+# install dependencies
+# 
+# pytest-cov - code coverage extension for pytest
+# sphinx - documentation
+# twine - release automation
+install:
+	python3 -m pip install -U setuptools
+	python3 -m pip install -r requirements.txt
+	python3 -m pip install pylint
+	python3 -m pip install pytest-cov
+	python3 -m pip install twine
+	python3 -m pip install sphinx
+
+readme:
+	erb -T '-' README.md.erb > README.md
+
+doc: readme
+	$(MAKE) -C docs/ html
+
+# https://packaging.python.org/tutorials/packaging-projects/
+build: 
+	python3 setup.py sdist
+
+# out of box testing / user acceptance before delivery
+oobt: build
+	python3 -m pip install ./${dist}
+	python3 oobt/demo.py
+
+
+check: oobt
+	python3 -m twine check ${dist}
+
+release: # check
+	python3 -m twine upload ${dist}
+
+# run example only 
+#  and display output (-s)
+example:
+	python3 -m pytest -s "tests/test_example.py::TestExample::test_async"