Merge pull request #4 from fireeye/feature/presigned-url

Fixed comments in fireeyepy that incorrectly described the behavior o…

Author: mckibbenc

README.md

@@ -4,6 +4,8 @@
 # FireEye Client Library for Python
 This is the Python client library for all things FireEye API. Currently it only supports FireEye's Detection On Demand but will have support for other FireEye API's soon.
 
+For more API information, visit the [FireEye Developer Hub](https://fireeye.dev)
+
 Installation
 ------------
 
@@ -34,6 +36,8 @@ Construct a Detection object with your api key:
 ```python
 detection = fireeyepy.Detection(key=api_key)
 ```
+To obtain a free trial API key, subscribe on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B07XSMKK41)
+
 ### Upload A File
 ```python
 response = detection.submit_file(
@@ -52,6 +56,11 @@ You may also provide the optional `extended=True` flag to get the full, in-depth
 response = detection.get_report(report_id, extended=True)
 ```
 
+### Retrieve Presigned URL for Dashboard Report
+```python
+result = detection.get_presigned_url(report_id)
+```
+
 ### Perform Hash Lookup
 ```python
 response = detection.get_hash(hash)

fireeyepy/__init__.py

@@ -5,7 +5,7 @@
 import requests
 import logging
 
-__version__ = "0.0.1"
+__version__ = "0.1.0"
 logger = logging.getLogger("fireeye")
 
 class Detection:
@@ -28,7 +28,7 @@ class Detection:
 
   result = detection.submit_file(
     files={
-      "file": ("filenamehere.txt", open("path/to/filenamehere.txt", "r"))
+      "file": ("filenamehere.txt", open("path/to/filenamehere.txt", "rb"))
     }
   )
   ```
@@ -40,7 +40,17 @@ class Detection:
 
   detection = fireeyepy.Detection(key="yourapikeyhere")
 
-  result = detection.get_file_result("yoursubmissionkey")
+  result = detection.get_report("report_id")
+  ```
+  ------------------------------
+
+  Example of getting a presigned URL for a browser viewable report
+  ```python
+  import fireeyepy
+
+  detection = fireeyepy.Detection(key="yourapikeyhere")
+
+  result = detection.get_presigned_url("report_id")
   ```
   ------------------------------
 
@@ -75,13 +85,21 @@ def submit_file(self, body=None, files=None):
     return self.post(self.api_host, "/files", body, files)
 
   def get_report(self, report_id, extended=False):
-    """Allows you to get a list of all of your submissions.
+    """Allows you to get the report details for a file or hash submission.
     
     Returns:
-        dict -- Returns a dict of all of the submissions under your API key.
+        dict -- Returns the report details
     """
     return self.get(self.api_host, "/reports/{}".format(report_id), {"extended": extended})
 
+  def get_presigned_url(self, report_id, expiry=72):
+    """Allows you to get a presigned URL for a browser viewable version of the analysis report
+    
+    Returns:
+        dict -- Returns the presigned URL details
+    """
+    return self.get(self.api_host, "/presigned-url/{}".format(report_id), {"expiry": expiry})
+
   def get_hash(self, hash):
     """Allows you to get the malware analysis results for a given hash.
     

setup.py

@@ -1,14 +1,21 @@
 # Copyright (C) 2019 FireEye, Inc. All Rights Reserved.
 from setuptools import setup
 
+with open("README.md", "r") as fh:
+  long_description = fh.read()
+
 setup(
   name="fireeyepy",
-  version="0.0.1",
+  version="0.1.0",
   description="FireEye Client Library for Python",
+  long_description=long_description,
+  long_description_content_type="text/markdown",
   url="https://github.com/fireeye/fireeye-python",
   author="FireEye",
+  author_email="[email protected]",
   license="MIT",
   packages=["fireeyepy"],
   platforms=["any"],
-  install_requires=["requests>=2.4.2"]
+  install_requires=["requests>=2.4.2"],
+  python_requires='>=3.6',
 )