OWASP ZAP Python API

The Python implementation to access the OWASP ZAP API. For more information about OWASP ZAP consult the (main) OWASP ZAP project.

How to Obtain

The latest released version can be downloaded from the https://pypi.python.org/pypi/python-owasp-zap-v2.4 using:

pip install python-owasp-zap-v2.4

Getting Help

For help using OWASP ZAP API refer to:

• Examples - collection of examples using the library;
• Wiki
• OWASP ZAP User Group - for asking questions;
• IRC: irc.mozilla.org #websectools (eg using Mibbit) - chat with core ZAP developers (European office hours usually best)

Issues

To report issues related to OWASP ZAP API, bugs and enhancements requests, use the issue tracker of the main OWASP ZAP project.

Release to PyPi

Example commands use the version 0.0.1, it should be replaced accordingly to the version being released.

Tag (and push) the new version:

git tag -s 0.0.1 -m "Version 0.0.1."
git push upstream 0.0.1

(Checkout the tag and ensure the working copy is clean.)

Build the distribution (source and wheel) files:

python setup.py sdist bdist_wheel --universal

Sign the distribution files:

gpg --detach-sign -a dist/python-owasp-zap-v2.4-0.0.1.tar.gz
gpg --detach-sign -a dist/python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl

Upload to PyPi:

 twine upload \
     dist/python-owasp-zap-v2.4-0.0.1.tar.gz python-owasp-zap-v2.4-0.0.1.tar.gz.asc \
     dist/python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl.asc

The user must have permissions to upload to the python-owasp-zap-v2.4 package.