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

README updated including keys.py usage

pull/3/head
Alexandre Dulaunoy 2015-11-06 11:40:43 +01:00
parent 2cdf1aa88d
commit ca262ca4c1
1 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,22 +1,42 @@
# PyMISP - Python Library to access MISP
PyMISP is a Python library to access [MISP](https://github.com/MISP/MISP) platforms via their REST API.
Requirements
------------
PyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.
## Requirements
* [requests](http://docs.python-requests.org)
Install
-------
## Install
~~~~
python setup.py install
~~~~
Example
-------
## Samples and how to use PyMISP
An example to copy events between MISP instances is included in examples/
Various examples and samples scripts are in the [examples/](examples/) directory.
Documentation
-------------
In the examples directory, you will need to change the keys.py.sample to enter your MISP url and API key.
~~~~
cd examples
cp keys.py.sample keys.py
vim keys.py
~~~~
The API key of MISP is available in the Automation section of the MISP web interface.
To test if your URL and API keys are correct, you can test with examples/last.py to
fetch the last 10 events published.
~~~~
cd examples
python last.py -l 10
~~~~
## Documentation
[PyMISP API documentation is available](http://www.circl.lu/assets/files/PyMISP.pdf).