MISP
/
PyMISP
mirror of https://github.com/MISP/PyMISP
2
0
Fork 0
Code Issues Releases Wiki Activity
PyMISP/docs/source
History
Raphaël Vinot e304535b72 Improve document generation 2017-07-20 16:46:19 +02:00
..
README.md Improve document generation 2017-07-20 16:46:19 +02:00
conf.py Improve document generation 2017-07-20 16:46:19 +02:00
index.rst Improve document generation 2017-07-20 16:46:19 +02:00
modules.rst Add doc 2016-08-26 12:00:13 +02:00
pymisp.rst Add doc 2016-08-26 12:00:13 +02:00

README.md

README

Documentation Status Build Status Coverage Status

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.

Requirements

Install from pip

pip3 install pymisp

Install the latest version from repo

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

Samples and how to use PyMISP

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

PyMISP API documentation is available.

Documentation can be generated with epydoc:

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