Skip to content

Commit 7aff9d3

Browse files
committed
Merge commit '7a6fdbb32b3a56d88bb640a0a5547041748a1505' into codex/pr44-readme-followups
# Conflicts: # README.md
2 parents c20e70c + 7a6fdbb commit 7aff9d3

19 files changed

Lines changed: 552 additions & 47 deletions

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!-- Use "None" or "N/A" where appropriate. -->
2+
3+
## Summary
4+
5+
<!-- What changed and why? For bug fixes, describe the previous and expected behavior. Mention breaking changes to public methods, parameters, return values, exceptions, Python support, or dependencies, and any migration steps. -->
6+
7+
## Type
8+
9+
- [ ] Bug fix
10+
- [ ] Feature
11+
- [ ] Refactor / performance
12+
- [ ] Documentation / examples
13+
- [ ] Tests
14+
- [ ] Maintenance / packaging / CI
15+
16+
## Related issue
17+
18+
<!-- Link the issue, use "Closes #123" if fully resolved, or explain why there is no issue. -->
19+
20+
## Affected SDK functionality
21+
22+
- `serpapi` package version (if known):
23+
- Python version and operating system:
24+
- SDK methods or helpers affected:
25+
- SerpApi engine or endpoint involved (if applicable):
26+
- Other affected Python versions or environments (confirmed or suspected):
27+
28+
## Testing
29+
30+
<!-- List checks actually completed and their results. Include commands, Python versions tested, and reproduction steps where useful. State whether tests used mocked responses or live SerpApi requests. See CONTRIBUTING.md for test, documentation, and package build commands. Write "None" if no testing was done. -->
31+
32+
- Human testing:
33+
- AI-executed testing:
34+
- CI results, failures, or tests skipped (with reasons):
35+
36+
## AI disclosure
37+
38+
<!-- List AI used for this contribution, or write "None". Use "Unknown" if a model/version is not exposed. -->
39+
40+
- Model(s):
41+
- Harness/app(s) (e.g., Codex, Claude Code, Cursor):
42+
- Used for (e.g., coding, tests, review, documentation):
43+
44+
## Evidence
45+
46+
<!-- Include a minimal Python example, before/after output, traceback, or sanitized request/response when useful. Add screenshots for visible documentation changes. Remove API keys and private data, including values in request URLs and logs. Write "N/A" if not relevant. -->

‎.github/workflows/ci.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616
strategy:
1717
matrix:
18-
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
18+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
1919

2020
steps:
2121
- name: Checkout repository
@@ -36,7 +36,7 @@ jobs:
3636
API_KEY: ${{ secrets.API_KEY }}
3737

3838
- name: Run example tests
39-
if: matrix.python-version == '3.14'
39+
if: matrix.python-version == '3.15'
4040
run: pytest tests/example_search_*_test.py
4141
env:
4242
API_KEY: ${{ secrets.API_KEY }}

‎.github/workflows/release.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
strategy:
2222
matrix:
23-
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
23+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
2424
steps:
2525
- uses: actions/checkout@v6
2626

@@ -43,7 +43,7 @@ jobs:
4343
API_KEY: ${{ secrets.API_KEY }}
4444

4545
- name: Run engine and documentation examples
46-
if: matrix.python-version == '3.14'
46+
if: matrix.python-version == '3.15'
4747
continue-on-error: ${{ inputs.allow_example_test_failures == true }}
4848
run: pytest --ignore=tests/test_docs_publishing.py -k "example" --require-docs-key
4949
env:

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Bug reports and pull requests are welcome on GitHub. Run commands from the repos
44

55
## Development setup
66

7-
Use Python 3.13 to work on the package and its documentation. The SDK CI also tests Python 3.8 through 3.14. Create a virtual environment and install the package with its test and documentation dependencies:
7+
The SDK CI tests Python 3.8 through 3.15. Create a virtual environment and install the package with its test and documentation dependencies:
88

99
```sh
1010
uv venv --python 3.13
@@ -31,10 +31,10 @@ The commands below use `python` from that environment.
3131

3232
### Checks that need no API key
3333

34-
These tests cover response parsing, image uploads with simulated responses, timeouts, exceptions, documentation syntax, and the example runner:
34+
These tests cover response parsing, image uploads and extraction with simulated responses, timeouts, exceptions, documentation syntax, and the example runner:
3535

3636
```sh
37-
python -m pytest tests/test_output_formats.py tests/test_image_upload.py tests/test_timeout.py tests/test_exceptions.py tests/test_docs_examples.py tests/test_docs_example_runner.py -k 'not live' -q
37+
python -m pytest tests/test_output_formats.py tests/test_image_upload.py tests/test_extract.py tests/test_timeout.py tests/test_exceptions.py tests/test_docs_examples.py tests/test_docs_example_runner.py -k 'not live' -q
3838
```
3939

4040
The file list limits this command to tests that make no external requests. Applying `-k 'not live'` to the entire suite is not enough to run offline: some SDK integration tests do not have `live` in their names.
@@ -61,7 +61,7 @@ This includes live account, location, search, and pagination checks. To run ever
6161
python -m pytest -q
6262
```
6363

64-
Both commands make real SerpApi requests. The full suite can use more searches than a test run limited to the files you changed. PR CI also runs the standalone engine examples on Python 3.14. Documentation tests run in the package and documentation release workflows on release tags, and in manual documentation runs on `master`.
64+
Both commands make real SerpApi requests. The full suite can use more searches than a test run limited to the files you changed. PR CI also runs the standalone engine examples on Python 3.15. Documentation tests run in the package and documentation release workflows on release tags, and in manual documentation runs on `master`.
6565

6666
### Testing documentation examples
6767

@@ -150,7 +150,7 @@ The [documentation workflow](.github/workflows/docs.yml) runs the live examples
150150

151151
After the live examples and documentation build pass, the same workflow publishes to Read the Docs for the selected ref. A manual run on `master` updates `latest` without triggering the package release workflow or changing the package version. The publishing job uses the `docs` GitHub environment and its `RTD_API_TOKEN` secret. The SerpApi key stays in GitHub as the existing `API_KEY` repository or organization secret.
152152

153-
The workflow syncs RTD versions, activates the requested version if needed, and waits for the build to finish. `latest` tracks `master`. A release tag has its own version and also updates `stable` when RTD identifies it as the highest stable release. RTD still builds the site from the repository using [.readthedocs.yaml](.readthedocs.yaml); it does not receive the HTML artifact from GitHub. Documentation publishing runs independently of the PyPI release workflow.
153+
The workflow syncs RTD versions, activates the requested version if needed, and waits for the build to finish. `latest` tracks `master`. A release tag has its own version and also rebuilds both `stable` and `latest` when RTD identifies it as the highest stable release. Both builds must use the release commit tested by CI. If `master` has advanced beyond that commit, the `latest` build fails the revision check; run the Documentation workflow on `master` to test and publish its current docs. Older releases and prereleases do not update either alias. RTD still builds the site from the repository using [.readthedocs.yaml](.readthedocs.yaml); it does not receive the HTML artifact from GitHub. Documentation publishing runs independently of the PyPI release workflow.
154154

155155
Before requesting a build, the workflow creates a temporary RTD environment variable named `DOCS_CI_REVISION`. It contains the tested commit, the permitted versions, and an expiration time. RTD checks this record against its checkout before and after the Sphinx build. A missing, expired, or different revision stops publication. RTD needs no SerpApi key. The workflow removes the temporary record after publishing, including when a build fails. Publishing jobs run one at a time so they cannot overwrite each other's revision record.
156156

‎HISTORY.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Release History
22
===============
33

4+
1.2.0 (2026-10-30)
5+
------------------
6+
7+
- Add Extract API support through `client.extract()` and `serpapi.extract()` for scraping, URL discovery, and crawling.
8+
- Add Extract API documentation, examples, and tests.
9+
- Add Python 3.15 to the test matrix.
10+
411
1.1.2 (2026-09-15)
512
------------------
613

0 commit comments

Comments
 (0)