Merge pull request #141 from SteveClement/master

Remove CIRCL repo references from README.md & fix epydoc
pull/142/head
Raphaël Vinot 2017-11-19 12:41:44 +01:00 committed by GitHub
commit 635d9df8c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions

View File

@ -24,7 +24,7 @@ pip3 install pymisp
## Install the latest version from repo ## Install the latest version from repo
``` ```
git clone https://github.com/CIRCL/PyMISP.git && cd PyMISP git clone https://github.com/MISP/PyMISP.git && cd PyMISP
pip3 install -I . pip3 install -I .
``` ```
@ -84,7 +84,7 @@ logging.basicConfig(level=logging.DEBUG, filename="debug.log", filemode='w', for
Documentation can be generated with epydoc: Documentation can be generated with epydoc:
``` ```
epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc epydoc --url https://github.com/MISP/PyMISP --graph all --name PyMISP --pdf pymisp -o doc
``` ```
## Everything is a Mutable Mapping ## Everything is a Mutable Mapping

View File

@ -68,9 +68,9 @@ class PyMISP(object):
:param url: URL of the MISP instance you want to connect to :param url: URL of the MISP instance you want to connect to
:param key: API key of the user you want to use :param key: API key of the user you want to use
:param ssl: can be True or False (to check ot not the validity :param ssl: can be True or False (to check ot not the validity
of the certificate. Or a CA_BUNDLE in case of self of the certificate. Or a CA_BUNDLE in case of self
signed certiifcate (the concatenation of all the signed certiifcate (the concatenation of all the
*.crt of the chain) *.crt of the chain)
:param out_type: Type of object (json) NOTE: XML output isn't supported anymore, keeping the flag for compatibility reasons. :param out_type: Type of object (json) NOTE: XML output isn't supported anymore, keeping the flag for compatibility reasons.
:param debug: Write all the debug information to stderr :param debug: Write all the debug information to stderr
:param proxies: Proxy dict as describes here: http://docs.python-requests.org/en/master/user/advanced/#proxies :param proxies: Proxy dict as describes here: http://docs.python-requests.org/en/master/user/advanced/#proxies
@ -902,8 +902,8 @@ class PyMISP(object):
analysis=None, attribute=None, org=None, async_callback=None, normalize=False): analysis=None, attribute=None, org=None, async_callback=None, normalize=False):
"""Search only at the index level. Use ! infront of value as NOT, default OR """Search only at the index level. Use ! infront of value as NOT, default OR
If using async, give a callback that takes 2 args, session and response: If using async, give a callback that takes 2 args, session and response:
basic usage is basic usage is
pymisp.search_index(..., async_callback=lambda ses,resp: print(resp.json())) pymisp.search_index(..., async_callback=lambda ses,resp: print(resp.json()))
:param published: Published (0,1) :param published: Published (0,1)
:param eventid: Evend ID(s) | str or list :param eventid: Evend ID(s) | str or list