Python library using the MISP Rest API

Go to file

Alexandre Dulaunoy ac72db8a48 Merge pull request #105 from Deventual/patch-10 Update README.md		2017-08-06 18:15:27 +02:00
docs	Improve document generation	2017-07-20 16:46:19 +02:00
examples	Fix shebangs and executable permissions	2017-07-24 13:27:28 +02:00
pymisp	Improve event ID detection in publish method	2017-08-04 19:30:40 +02:00
tests	Improve event ID detection in publish method	2017-08-04 19:30:40 +02:00
.gitchangelog.rc	add: gitchangelogrc configuration file added	2017-04-28 16:12:17 +02:00
.gitignore	new: Added ability to add attachments to events	2017-01-13 13:15:53 +00:00
.travis.yml	Run on more python versions	2017-01-24 09:50:34 +01:00
CHANGELOG.txt	new: Added changelog in-repo	2017-05-09 15:46:29 +01:00
LICENSE	…
MANIFEST.in	Getting closed to a full support of a misp event as a Python Object	2016-09-27 19:47:22 +02:00
README.md	Update README.md	2017-08-06 18:03:22 +03:00
setup.cfg	Fix PyPi package.	2015-08-05 17:48:15 +02:00
setup.py	Fix package installation	2016-11-04 14:32:29 +01:00

README

PyMISP - Python Library to access MISP

PyMISP is a Python library to access MISP platforms via their REST API.

PyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.

pip3 install pymisp

git clone https://github.com/CIRCL/PyMISP.git && cd PyMISP
python3 setup.py install

Various examples and samples scripts are in the examples/ directory.

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
python3 last.py -l 10

Documentation can be generated with epydoc:

epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc