Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix regression in core library #8

Merged
merged 2 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ Some SIEM tools have different ways of getting the data into their system.
The connectors supported by this script have some shared configuration in order to pull the data from Socket.

### Options
| Option | Required | Format | Description |
|-----------|----------|------------------|---------------------------------------------------------------------------------------------------------------------------|
| api_key | True | string | This is the Socket API Key created in the Socket dashboard. This should have the scoped permissions to access reports |
| from_time | False | int | This is the number of seconds to pull reports from. If this is not defined then it will pull the last 30 days of reports. |
| report_id | False | Socket Report ID | If this is provided then only the specified report ID will be processed |
| Option | Required | Format | Description |
|-----------------|----------|------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| api_key | True | string | This is the Socket API Key created in the Socket dashboard. This should have the scoped permissions to access reports |
| from_time | False | int | This is the number of seconds to pull reports from. If this is not defined then it will pull the last 30 days of reports. |
| report_id | False | Socket Report ID | If this is provided then only the specified report ID will be processed |
| request_timeout | False | int | This is the number of seconds to wait for an API request to complete before killing it and returning an error. Defaults to 30 seconds |


### Example
Expand All @@ -43,7 +44,8 @@ if __name__ == '__main__':
core = Core(
api_key=api_key,
start_date=start_date,
report_id=report_id
report_id=report_id,
request_timeout=300
)
issue_data = core.get_issues()
```
Expand Down
3 changes: 2 additions & 1 deletion socket-integration-example.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
core = Core(
api_key=api_key,
from_time=from_time,
default_branch_only=False
default_branch_only=False,
request_timeout=300
)
issue_data = core.get_issues()

Expand Down
3 changes: 2 additions & 1 deletion socketsync/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import logging


__author__ = 'socket.dev'
__version__ = '1.0.3'
__version__ = '1.0.5'
__all__ = [
"log",
"__version__",
Expand Down
2 changes: 1 addition & 1 deletion socketsync/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def set_timeout(request_timeout: int):
"""
global timeout
timeout = request_timeout
socket.set_timeout(timeout)
socketdev.set_timeout(timeout)

@staticmethod
def get_org_id_slug() -> (str, str):
Expand Down