MISP
/
PyMISP
mirror of https://github.com/MISP/PyMISP
2
0
Fork 0
Code Issues Releases Wiki Activity
Python library using the MISP Rest API
560 Commits
13 Branches
166 Tags
93 MiB
Go to file
Paul A 9bfa24155c Normalize output between misp.search_index and misp.search 
Fix issue: https://github.com/CIRCL/PyMISP/issues/78
 		2017-05-03 10:32:14 +02:00
docs Fix documentation generation 2016-11-15 11:03:51 +01:00
examples Fixed the JSON output format (\n breaks JSON loading afterwards) 2017-05-02 16:27:37 +02:00
pymisp Normalize output between misp.search_index and misp.search 2017-05-03 10:32:14 +02:00
tests Update offline tests 2017-04-13 17:02:48 +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
LICENSE add license 2014-12-09 14:54:45 +01:00
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 Install PyMISP with python3 by default. 2017-02-27 11:43:46 +01: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.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 lastest 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