Skip to content

Commit d71bda5

Browse files
Updated setup.py and README for 0.1.0 release
1 parent d1c03fd commit d71bda5

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
# FireEye Client Library for Python
55
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.
66

7+
For more API information, visit the [FireEye Developer Hub](https://fireeye.dev)
8+
79
Installation
810
------------
911

@@ -34,6 +36,8 @@ Construct a Detection object with your api key:
3436
```python
3537
detection = fireeyepy.Detection(key=api_key)
3638
```
39+
To obtain a free trial API key, subscribe on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B07XSMKK41)
40+
3741
### Upload A File
3842
```python
3943
response = detection.submit_file(
@@ -52,6 +56,11 @@ You may also provide the optional `extended=True` flag to get the full, in-depth
5256
response = detection.get_report(report_id, extended=True)
5357
```
5458

59+
### Retrieve Presigned URL for Dashboard Report
60+
```python
61+
result = detection.get_presigned_url(report_id)
62+
```
63+
5564
### Perform Hash Lookup
5665
```python
5766
response = detection.get_hash(hash)

fireeyepy/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class Detection:
2828
2929
result = detection.submit_file(
3030
files={
31-
"file": ("filenamehere.txt", open("path/to/filenamehere.txt", "r"))
31+
"file": ("filenamehere.txt", open("path/to/filenamehere.txt", "rb"))
3232
}
3333
)
3434
```

setup.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Copyright (C) 2019 FireEye, Inc. All Rights Reserved.
22
from setuptools import setup
33

4+
with open("README.md", "r") as fh:
5+
long_description = fh.read()
6+
47
setup(
58
name="fireeyepy",
69
version="0.1.0",
710
description="FireEye Client Library for Python",
11+
long_description=long_description,
12+
long_description_content_type="text/markdown",
813
url="https://github.com/fireeye/fireeye-python",
914
author="FireEye",
15+
author_email="[email protected]",
1016
license="MIT",
1117
packages=["fireeyepy"],
1218
platforms=["any"],
13-
install_requires=["requests>=2.4.2"]
19+
install_requires=["requests>=2.4.2"],
20+
python_requires='>=3.6',
1421
)

0 commit comments

Comments
 (0)