REQUEST_TIMEOUT variable now lives as env variable

Author: kompotkot

.gitignore

@@ -138,3 +138,4 @@ dmypy.json
 .secrets/
 .bugout/
 test/
+dev.env

README.md

@@ -1,6 +1,12 @@
 # bugout-python
 Python client library for Bugout API
 
+## Setup
+- Add variables from `sample.env` in you development environment
+```bash
+export BUGOUT_REQUESTS_TIMEOUT=5
+```
+
 ```python
 from bugout.app import Bugout
 

bugout/app.py

@@ -2,10 +2,11 @@
 import uuid
 
 from . import data
-from .calls import ping, REQUESTS_TIMEOUT
+from .calls import ping
 from .group import Group
 from .journal import Journal
 from .user import User
+from .settings import REQUESTS_TIMEOUT
 
 
 class InvalidParameters(ValueError):

bugout/calls.py

@@ -4,8 +4,6 @@
 
 from .data import Method
 
-REQUESTS_TIMEOUT = 5
-
 
 class InvalidUrlSpec(ValueError):
     """

bugout/group.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec, REQUESTS_TIMEOUT
+from .calls import make_request, InvalidUrlSpec
 from .data import (
     Method,
     Role,
@@ -10,6 +10,7 @@
     BugoutGroupMembers,
     BugoutUserGroups,
 )
+from .settings import REQUESTS_TIMEOUT
 
 
 class GroupInvalidParameters(ValueError):

bugout/journal.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec, REQUESTS_TIMEOUT
+from .calls import make_request, InvalidUrlSpec
 from .data import (
     BugoutJournal,
     BugoutJournals,
@@ -16,6 +16,7 @@
     HolderType,
     Method,
 )
+from .settings import REQUESTS_TIMEOUT
 
 
 class Journal:

bugout/settings.py

@@ -0,0 +1,11 @@
+import os
+
+REQUESTS_TIMEOUT = 5
+REQUESTS_TIMEOUT_RAW = os.environ.get("BUGOUT_REQUESTS_TIMEOUT")
+try:
+    if REQUESTS_TIMEOUT_RAW is not None:
+        REQUESTS_TIMEOUT = int(REQUESTS_TIMEOUT_RAW)
+except:
+    raise Exception(
+        f"Could not parse BUGOUT_REQUESTS_TIMEOUT environment variable as int: {REQUESTS_TIMEOUT_RAW}"
+    )

bugout/user.py

@@ -1,8 +1,9 @@
 from typing import Any, Dict, List, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec, REQUESTS_TIMEOUT
+from .calls import make_request, InvalidUrlSpec
 from .data import Method, TokenType, BugoutUser, BugoutToken, BugoutUserTokens
+from .settings import REQUESTS_TIMEOUT
 
 
 class TokenInvalidParameters(ValueError):

sample.env

@@ -0,0 +1 @@
+export BUGOUT_REQUESTS_TIMEOUT=5