Metadata-Version: 2.1
Name: pymisp
Version: 2.4.102
Summary: Python API for MISP.
Home-page: https://github.com/MISP/PyMISP
Author: Raphaël Vinot
Author-email: raphael.vinot@circl.lu
Maintainer: Raphaël Vinot
License: UNKNOWN
Project-URL: Tracker, https://github.com/MISP/PyMISP/issues
Project-URL: Source, https://github.com/MISP/PyMISP
Project-URL: Documentation, http://pymisp.readthedocs.io
Description: README
        ======
        
        [![Documentation Status](https://readthedocs.org/projects/pymisp/badge/?version=latest)](http://pymisp.readthedocs.io/?badge=latest)
        [![Build Status](https://travis-ci.org/MISP/PyMISP.svg?branch=master)](https://travis-ci.org/MISP/PyMISP)
        [![Coverage Status](https://coveralls.io/repos/github/MISP/PyMISP/badge.svg?branch=master)](https://coveralls.io/github/MISP/PyMISP?branch=master)
        
        # PyMISP - Python Library to access MISP
        
        PyMISP is a Python library to access [MISP](https://github.com/MISP/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
        
         * [requests](http://docs.python-requests.org)
        
        ## Install from pip
        
        ```
        pip3 install pymisp
        ```
        
        ## Install the latest version from repo
        
        ```
        git clone https://github.com/MISP/PyMISP.git && cd PyMISP
        git submodule update --init
        pip3 install -I .[fileobjects,neo,openioc,virustotal]
        ```
        
        ## Installing it with virtualenv
        
        It is recommended to use virtualenv to not polute your OS python envirenment.
        ```
        pip3 install virtualenv
        git clone https://github.com/MISP/PyMISP.git && cd PyMISP
        python3 -m venv ./
        source venv/bin/activate
        git submodule update --init
        pip3 install -I .[fileobjects,neo,openioc,virustotal]
        ```
        
        ## Running the tests
        
        ```bash
        pip3 install -U nose pip setuptools coveralls codecov requests-mock
        pip3 install git+https://github.com/kbandla/pydeep.git
        
        git clone https://github.com/viper-framework/viper-test-files.git tests/viper-test-files
        nosetests-3.4 --with-coverage --cover-package=pymisp,tests --cover-tests tests/test_*.py
        ```
        
        If you have a MISP instance to test against, you can also run the live ones:
        
        **Note**: You need to update the key in `tests/testlive_comprehensive.py` to the automation key of your admin account.
        
        ```bash
        nosetests-3.4 --with-coverage --cover-package=pymisp,tests --cover-tests tests/testlive_comprehensive.py
        ```
        
        ## Samples and how to use PyMISP
        
        Various examples and samples scripts are in the [examples/](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 events published in the last x amount of time (supported time indicators: days (d), hours (h) and minutes (m)).
        last.py
        ```
        cd examples
        python3 last.py -l 10h # 10 hours
        python3 last.py -l 5d  #  5 days
        python3 last.py -l 45m # 45 minutes
        ```
        
        
        ## Debugging
        
        You have two options there:
        
        1. Pass `debug=True` to `PyMISP` and it will enable logging.DEBUG to stderr on the whole module
        
        2. Use the python logging module directly:
        
        ```python
        
        import logging
        logger = logging.getLogger('pymisp')
        
        # Configure it as you whish, for example, enable DEBUG mode:
        logger.setLevel(logging.DEBUG)
        ```
        
        Or if you want to write the debug output to a file instead of stderr:
        
        ```python
        import pymisp
        import logging
        
        logger = logging.getLogger('pymisp')
        logging.basicConfig(level=logging.DEBUG, filename="debug.log", filemode='w', format=pymisp.FORMAT)
        ```
        
        ## Documentation
        
        [PyMISP API documentation is available](https://media.readthedocs.org/pdf/pymisp/latest/pymisp.pdf).
        
        Documentation can be generated with epydoc:
        
        ```
        epydoc --url https://github.com/MISP/PyMISP --graph all --name PyMISP --pdf pymisp -o doc
        ```
        
        ## Everything is a Mutable Mapping
        
        ... or at least everything that can be imported/exported from/to a json blob
        
        `AbstractMISP` is the master class, and inherit `collections.MutableMapping` which means
        the class can be represented as a python dictionary.
        
        The abstraction assumes every property that should not be seen in the dictionary is prepended with a `_`,
        or its name is added to the private list `__not_jsonable` (accessible through `update_not_jsonable` and `set_not_jsonable`.
        
        This master class has helpers that will make it easy to load, and export, to, and from, a json string.
        
        `MISPEvent`, `MISPAttribute`, `MISPObjectReference`, `MISPObjectAttribute`, and `MISPObject`
        are subclasses of AbstractMISP, which mean that they can be handled as python dictionaries.
        
        ## MISP Objects
        
        Creating a new MISP object generator should be done using a pre-defined template and inherit `AbstractMISPObjectGenerator`.
        
        Your new MISPObject generator need to generate attributes, and add them as class properties using `add_attribute`.
        
        When the object is sent to MISP, all the class properties will be exported to the JSON export.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: Internet
Description-Content-Type: text/markdown
Provides-Extra: fileobjects
Provides-Extra: openioc
Provides-Extra: virustotal
Provides-Extra: neo
