MISP
/
PyMISP
mirror of https://github.com/MISP/PyMISP
2
0
Fork 0
Code Issues Releases Wiki Activity

Documentation reference added

pull/1/head
Alexandre Dulaunoy 2014-10-29 10:45:18 +01:00
parent 81fd66d612
commit 6cab1800bb
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,4 +1,9 @@
Python API for MISP using the REST interface of the application via requests.
PyMISP is a Python library to access [MISP](https://github.com/MISP/MISP) platforms via their REST API.
Requirements
------------
* [requests](http://docs.python-requests.org)
Install
-------
@ -8,4 +13,15 @@ python setup.py install
Example
-------
An example is available in examples/
An example to copy events between MISP instances is included in examples/
Documentation
-------------
[PyMISP API documentation is available](http://www.circl.lu/assets/files/PyMISP.pdf).
Documentation can be generated with epydoc:
~~~~
epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc
~~~~