Merge pull request #4 from serpapi/kr-improvements

re-write of python client

Author: Kenneth Reitz

.github/workflows/ci.yml

@@ -18,22 +18,18 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout repository
+      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
+      run: pip install -e .[test]
+
     - name: Test with pytest
       run: pytest
       env:

.gitignore

@@ -1,11 +1,18 @@
+.vscode/**
+
 script/
 .coverage
 docs/build
 dist/
+build/
 .pytest_cache/
 serpapi.egg-info/
 
-serpapi/__pycache__
-tests/__pycache__
+
+__pycache__
 *.pyc
 .DS_Store
+.envrc
+
+.vscode
+t.py

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

HISTORY.md

@@ -0,0 +1,12 @@
+Release History
+===============
+
+dev
+---
+
+* Initial release
+
+1.0.0 (planned)
+---------------
+
+- First planned release

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2022 SerpApi
+Copyright (c) 2018-2023 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

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md HISTORY.md LICENSE
+recursive-include tests *.py

MIT-LICENSE.txt

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+serpapi = {editable = true, path = "."}
+
+[dev-packages]
+alabaster = "*"
+sphinx = "*"
+pytest = "*"
+black = "*"