<commit_before>
![](images/thehive-logo.png)
# TheHive4py
TheHive4py is a Python API client for [TheHive](https://thehive-project.org/), a scalable 3-in-1 open source and free security incident response platform designed to make life easier for SOCs, CSIRTs, CERTs and any information security practitioner dealing with security incidents that need to be investigated and acted upon swiftly.

TheHive4py allows analysts to create cases out of different sources such as email. For example, the SOC may ask its constituency to send suspicious email reports to a specific mailbox that a script may poll at regular intervals. When a new email is received, the script will parse it then call TheHive4py to create the case in TheHive. Analysts will be informed that a new case has been created through TheHive's Flow and start their investigation right away.

# Caution - WIP
TheHive4py is a work-in-progress. TheHive authors use it on a regular basis and features will be added as the need arise.

Please note that a new version of TheHive will be released by the end of April / beginning of May 2017 and it will feature a Scala connector framework to handle alerts, which translate to cases if analysts deem them worth investigating, in a more generic and resilient fashion. The connector framework will allow SOCs and CERTs to interface TheHive with SIEMs, email and other services.

When the connector framework is published, TheHive authors may not maintain TheHive4py on the long run but since it is a FOSS, the community can fork it and enhance it the way they see fit. Pull requests will be reviewed by TheHive core team and accepted if they are OK.

# Use It

```
python setup.py install
pip install -e .
```
# License
TheHive4py is an open source and free software released under the [AGPL](https://github.com/CERT-BDF/TheHive/blob/master/LICENSE) (Affero General Public License). We, TheHive Project, are committed to ensure that TheHive4py will remain a free and open source project on the long-run.

# Updates
Information, news and updates are regularly posted on [TheHive Project Twitter account](https://twitter.com/thehive_project) and on [the blog](https://blog.thehive-project.org/).<commit_msg>use pip directly without resorting to setup.py to install the client<commit_after>
![](images/thehive-logo.png)
# TheHive4py
TheHive4py is a Python API client for [TheHive](https://thehive-project.org/), a scalable 3-in-1 open source and free security incident response platform designed to make life easier for SOCs, CSIRTs, CERTs and any information security practitioner dealing with security incidents that need to be investigated and acted upon swiftly.

TheHive4py allows analysts to create cases out of different sources such as email. For example, the SOC may ask its constituency to send suspicious email reports to a specific mailbox that a script may poll at regular intervals. When a new email is received, the script will parse it then call TheHive4py to create the case in TheHive. Analysts will be informed that a new case has been created through TheHive's Flow and start their investigation right away.

# Caution - WIP
TheHive4py is a work-in-progress. TheHive authors use it on a regular basis and features will be added as the need arise.

Please note that a new version of TheHive will be released by the end of April / beginning of May 2017 and it will feature a Scala connector framework to handle alerts, which translate to cases if analysts deem them worth investigating, in a more generic and resilient fashion. The connector framework will allow SOCs and CERTs to interface TheHive with SIEMs, email and other services.

When the connector framework is published, TheHive authors may not maintain TheHive4py on the long run but since it is a FOSS, the community can fork it and enhance it the way they see fit. Pull requests will be reviewed by TheHive core team and accepted if they are OK.

# Use It

```
pip install thehive4py
```
# License
TheHive4py is an open source and free software released under the [AGPL](https://github.com/CERT-BDF/TheHive/blob/master/LICENSE) (Affero General Public License). We, TheHive Project, are committed to ensure that TheHive4py will remain a free and open source project on the long-run.

# Updates
Information, news and updates are regularly posted on [TheHive Project Twitter account](https://twitter.com/thehive_project) and on [the blog](https://blog.thehive-project.org/).
{'fraction_non_alphanumeric': 0.04718040889687711, 'fraction_numerical': 0.006515389800044934, 'mean_word_length': 4.614123581336696, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1105005', 'n_tokens_mistral': 1182, 'n_tokens_neox': 1119, 'n_words': 660}