Merge branch 'release/2.0.0'

Author: nadouani

.gitignore

@@ -1,91 +1,17 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
+# Created by .ignore support plugin (hsz.mobi)
+.gitignore
+.idea/
+.vscode/
+tmp/
+*.pyc
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*,cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# IPython Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# dotenv
-.env
-
-# virtualenv
-venv/
-ENV/
-
-# Spyder project settings
-.spyderproject
-
-# Rope project settings
-.ropeproject
+build/
+*.egg-info
+build.sh
 
-.idea
+# Python Venv
+bin/
+lib/
+lib64
+pyvenv.cfg
+venv/

AUTHORS

@@ -1,16 +1,13 @@
 Authors
 -------
 
-* Thomas Franco <toom@thehive-project.org> (lead developer, back-end)
-* Saâd Kadhi <saad@thehive-project.org> (project leader, product management & design)
-* Jérôme Leonard <jerome@thehive-project.org> (developer, front-end, analyzers)
+* Nabil Adouani <nabil@thehive-project.org>
+* Thomas Franco <toom@thehive-project.org>
+* Saâd Kadhi <saad@thehive-project.org> (project leader)
+* Jérôme Leonard <jerome@thehive-project.org>
 
-Contributors
-------------
 
-* Nabil Adouani
-* CERT Banque de France (CERT-BDF)
-
-Copyright (C) 2017 Thomas Franco
-Copyright (C) 2017 Saâd Kadhi
-Copyright (C) 2017 Jérôme Leonard
+Copyright (C) 2017-2018 Nabil Adouani
+Copyright (C) 2017-2018 Thomas Franco
+Copyright (C) 2017-2018 Saâd Kadhi
+Copyright (C) 2017-2018 Jérôme Leonard

README.md

@@ -4,40 +4,30 @@
 # Cortex4py
 Cortex4py is a Python API client for [Cortex](https://thehive-project.org/), a powerful observable analysis engine where observables such as IP and email addresses, URLs, domain names, files or hashes can be analyzed one by one using a Web interface.
 
-Cortex4py allows analysts to automate these operations and submit observables in bulk mode through the Cortex REST API from alternative SIRP platforms and custom scripts.
+Cortex4py allows analysts to automate these operations and submit observables in bulk mode through the Cortex REST API from alternative SIRP platforms, custom scripts or MISP.
+
+
+# Features
+Cortex4py 2 is compatible with Cortex 2 and does not work with Cortex 1. It can:
+- Manage organizations
+- Manage users
+- Configure analyzers within an organization
+- List and launch analyzers
+
+For more details, please refer to the [full documentation](Usage.md).
+
+**Note**: Cortex4py 2 requires Python 3. It does not support Python 2.
 
 # Use It
 On macOS and Linux, type:
 ```
 sudo pip install cortex4py
 ```
 
-Following is an example of a Python script that runs an analysis using MaxMind analyzer:
-
-```python
-import sys
-import json
-from cortex4py.api import CortexApi
-from cortex4py.api import CortexException
-
-api = CortexApi('http://127.0.0.1:9000')
-
-# Run analysis
-job_id = None
-try:
-    response = api.run_analyzer("MaxMind_GeoIP_3_0", "ip", 1, "8.8.8.8")
-    job_id = response["id"]
-except CortexException as ex:
-    print('[ERROR]: Failed to run analyzer: {}'.format(ex.message))
-    sys.exit(0)
-
-# Get the job report
-try:
-    response = api.get_job_report(job_id, '30s')
-    print(json.dumps(response, indent=4, sort_keys=True))
-except CortexException as ex:
-    print('[ERROR]: Failed to get job report'.format(ex.message))
-    sys.exit(0)
+or, if you already have it, update it:
+
+```
+sudo pip install -U cortex4py
 ```
 
 If you are using Python on a Windows operating system, please forgo the `sudo` command.