You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 7aff9d3
Browse filesBrowse the repository at this point in the historyBrowse files
<!-- 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. -->
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Bug reports and pull requests are welcome on GitHub. Run commands from the repos
4
4
5
5
## Development setup
6
6
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:
8
8
9
9
```sh
10
10
uv venv --python 3.13
@@ -31,10 +31,10 @@ The commands below use `python` from that environment.
31
31
32
32
### Checks that need no API key
33
33
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:
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
61
61
python -m pytest -q
62
62
```
63
63
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`.
65
65
66
66
### Testing documentation examples
67
67
@@ -150,7 +150,7 @@ The [documentation workflow](.github/workflows/docs.yml) runs the live examples
150
150
151
151
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.
152
152
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.
154
154
155
155
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.
0 commit comments