Improve Python API agent documentation#1555
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve the Python API for agent-controlled scans, expand the Python API documentation into a practical guide, and align CI/package metadata around Python 3.11+.
Changes
docs/python-api.mdwith agent-oriented examples for custom wordlists, template generation, category-backed templates, callbacks, authenticated sessions, custom match predicates, scan recipes, and limits versus the CLI.WordlistTemplate.from_file(),WordlistTemplate.from_builtin(),Wordlist.from_template(..., max_entries=...), and publicWordlistLimitErrorexport.FuzzerConfigextension points for advanced library scans:result_predicate,session_factory, andraise_on_error.Validation
Wordlist,Wordlist.from_file(), template files, built-in templates, category templates,max_entries, callbacks, response fields, redirects, POST/data,result_predicate,session_factory, session closing, andraise_on_error..venv/bin/python -m unittest tests.core.test_importable_api tests.core.test_dictionary_templates.venv/bin/python testing.py.venv/bin/flake8 $(git ls-files '*.py').venv/bin/codespell -S CONTRIBUTORS.md,./db/categories/*.venv/bin/python -m pip install ..venv/bin/python tests/check_packaged_install.py && .venv/bin/dirsearch --version.venv/bin/python dirsearch.py -u https://example.com -w tests/static/wordlist.txt -qbash -n pyinstaller/build.shgit diff --check