Skip to content

Commit 01db43b

Browse files
authored
Update README.md
1 parent 64fae0f commit 01db43b

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# zap-api-python
2-
OWASP ZAP Python API
1+
# OWASP ZAP Python API
2+
3+
The Python implementation to access the [OWASP ZAP API](https://github.com/zaproxy/zaproxy/wiki/ApiDetails). For more information
4+
about OWASP ZAP consult the (main) [OWASP ZAP project](https://github.com/zaproxy/zaproxy/).
5+
6+
## How to Obtain
7+
8+
The latest released version can be downloaded from the [https://pypi.python.org/pypi/python-owasp-zap-v2.4](https://pypi.python.org/pypi/python-owasp-zap-v2.4) using:
9+
10+
pip install python-owasp-zap-v2.4
11+
12+
## Getting Help
13+
14+
For help using OWASP ZAP API refer to:
15+
* [Examples](https://github.com/zaproxy/zap-api-python/tree/master/src/examples) - collection of examples using the library;
16+
* [Wiki](https://github.com/zaproxy/zaproxy/wiki/ApiPython)
17+
* [OWASP ZAP User Group](https://groups.google.com/group/zaproxy-users) - for asking questions;
18+
* IRC: irc.mozilla.org #websectools (eg [using Mibbit](http://chat.mibbit.com/?server=irc.mozilla.org%3A%2B6697&channel=%23websectools)) - chat with core ZAP developers (European office hours usually best)
19+
20+
## Issues
21+
22+
To report issues related to OWASP ZAP API, bugs and enhancements requests, use the [issue tracker of the main OWASP ZAP project](https://github.com/zaproxy/zaproxy/issues).
23+
24+
### Release to PyPi
25+
26+
To build and upload to PyPi you can run the following:
27+
28+
python setup.py sdist upload
29+
30+
The user must have permissions to upload to the `python-owasp-zap-v2.4` package.

0 commit comments

Comments
 (0)