From cd324f9df92e468db058c5abe488720968c2320f Mon Sep 17 00:00:00 2001 From: Nabil Adouani Date: Wed, 8 Mar 2017 11:33:07 +0100 Subject: [PATCH] Include README.md convertion into setup.py file --- README.md | 1 + README.txt | 93 ------------------------------------------------------ setup.py | 9 +++++- 3 files changed, 9 insertions(+), 94 deletions(-) delete mode 100644 README.txt diff --git a/README.md b/README.md index 48780d96..1078ecf7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ ![](https://thehive-project.org/img/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. diff --git a/README.txt b/README.txt deleted file mode 100644 index eedacd4f..00000000 --- a/README.txt +++ /dev/null @@ -1,93 +0,0 @@ -TheHive4py -========== - -TheHive4py is a Python API client for -`TheHive `__, 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 -====== - -On macOS and Linux, type: - -:: - - sudo pip install thehive4py - -If you are using Python on a Windows operating system, please forgo the -``sudo`` command. - -License -======= - -TheHive4py is an open source and free software released under the -`AGPL `__ -(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 `__ and on `the -blog `__. - -Contributing -============ - -We welcome your contributions. Please feel free to fork the code, play -with it, make some patches and send us pull requests. - -Support -======= - -Please `open an issue on -GitHub `__ if you'd -like to report a bug or request a feature. - -If you need to contact the project team, send an email to -support@thehive-project.org. - -Community Discussions -===================== - -We have set up a Google forum at -https://groups.google.com/a/thehive-project.org/d/forum/users. To -request access, you need a Google account. You may create one `using a -Gmail address `__ or `without -one `__. - -Website -======= - -https://thehive-project.org/ diff --git a/setup.py b/setup.py index 04939694..e06e355a 100644 --- a/setup.py +++ b/setup.py @@ -2,11 +2,18 @@ # -*- coding: utf-8 -*- from setuptools import setup +try: + from pypandoc import convert + read_md = lambda f: convert(f, 'rst') +except ImportError: + print("warning: pypandoc module not found, could not convert Markdown to RST") + read_md = lambda f: open(f, 'r').read() + setup( name='thehive4py', version='1.0.0', description='Python API client for TheHive.', - long_description=open('README.txt').read(), + long_description=read_md('README.md'), author='TheHive-Project', author_email='support@thehive-project.org', maintainer='TheHive-Project',