hyperbrowser 0.10.0__tar.gz → 0.12.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of hyperbrowser might be problematic. Click here for more details.

Files changed (29) hide show
  1. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/PKG-INFO +5 -1
  2. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/README.md +4 -0
  3. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/async_client.py +7 -0
  4. hyperbrowser-0.12.0/hyperbrowser/client/managers/async_manager/extension.py +40 -0
  5. hyperbrowser-0.12.0/hyperbrowser/client/managers/async_manager/profile.py +25 -0
  6. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/async_manager/session.py +5 -1
  7. hyperbrowser-0.12.0/hyperbrowser/client/managers/sync_manager/extension.py +40 -0
  8. hyperbrowser-0.12.0/hyperbrowser/client/managers/sync_manager/profile.py +25 -0
  9. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/sync_manager/session.py +5 -1
  10. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/sync.py +6 -0
  11. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/models/consts.py +1 -1
  12. hyperbrowser-0.12.0/hyperbrowser/models/extension.py +27 -0
  13. hyperbrowser-0.12.0/hyperbrowser/models/profile.py +17 -0
  14. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/models/session.py +16 -1
  15. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/transport/async_transport.py +16 -2
  16. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/transport/base.py +4 -0
  17. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/transport/sync.py +16 -2
  18. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/pyproject.toml +1 -1
  19. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/LICENSE +0 -0
  20. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/__init__.py +0 -0
  21. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/base.py +0 -0
  22. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/async_manager/crawl.py +0 -0
  23. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/async_manager/scrape.py +0 -0
  24. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/sync_manager/crawl.py +0 -0
  25. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/client/managers/sync_manager/scrape.py +0 -0
  26. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/config.py +0 -0
  27. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/exceptions.py +0 -0
  28. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/models/crawl.py +0 -0
  29. {hyperbrowser-0.10.0 → hyperbrowser-0.12.0}/hyperbrowser/models/scrape.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: hyperbrowser
3
- Version: 0.10.0
3
+ Version: 0.12.0
4
4
  Summary: Python SDK for hyperbrowser
5
5
  Home-page: https://github.com/hyperbrowserai/python-sdk
6
6
  License: MIT
@@ -19,6 +19,10 @@ Requires-Dist: pydantic (>=2.10.0,<3.0.0)
19
19
  Project-URL: Repository, https://github.com/hyperbrowserai/python-sdk
20
20
  Description-Content-Type: text/markdown
21
21
 
22
+ # Hyperbrowser Python SDK
23
+
24
+ Checkout the full documentation [here](https://docs.hyperbrowser.ai/)
25
+
22
26
  ## Installation
23
27
 
24
28
  Currently Hyperbrowser supports creating a browser session in two ways:
@@ -1,3 +1,7 @@
1
+ # Hyperbrowser Python SDK
2
+
3
+ Checkout the full documentation [here](https://docs.hyperbrowser.ai/)
4
+
1
5
  ## Installation
2
6
 
3
7
  Currently Hyperbrowser supports creating a browser session in two ways:
@@ -1,7 +1,10 @@
1
1
  from typing import Optional
2
+
3
+ from .managers.async_manager.profile import ProfileManager
2
4
  from .managers.async_manager.session import SessionManager
3
5
  from .managers.async_manager.scrape import ScrapeManager
4
6
  from .managers.async_manager.crawl import CrawlManager
7
+ from .managers.async_manager.extension import ExtensionManager
5
8
  from .base import HyperbrowserBase
6
9
  from ..transport.async_transport import AsyncTransport
7
10
  from ..config import ClientConfig
@@ -15,11 +18,15 @@ class AsyncHyperbrowser(HyperbrowserBase):
15
18
  config: Optional[ClientConfig] = None,
16
19
  api_key: Optional[str] = None,
17
20
  base_url: Optional[str] = None,
21
+ timeout: Optional[int] = 30,
18
22
  ):
19
23
  super().__init__(AsyncTransport, config, api_key, base_url)
24
+ self.transport.client.timeout = timeout
20
25
  self.sessions = SessionManager(self)
21
26
  self.scrape = ScrapeManager(self)
22
27
  self.crawl = CrawlManager(self)
28
+ self.profiles = ProfileManager(self)
29
+ self.extensions = ExtensionManager(self)
23
30
 
24
31
  async def close(self) -> None:
25
32
  await self.transport.close()
@@ -0,0 +1,40 @@
1
+ import os
2
+ from typing import List
3
+
4
+ from hyperbrowser.exceptions import HyperbrowserError
5
+ from hyperbrowser.models.extension import CreateExtensionParams, ExtensionResponse
6
+
7
+
8
+ class ExtensionManager:
9
+ def __init__(self, client):
10
+ self._client = client
11
+
12
+ async def create(self, params: CreateExtensionParams) -> ExtensionResponse:
13
+ file_path = params.file_path
14
+ params.file_path = None
15
+
16
+ # Check if file exists before trying to open it
17
+ if not os.path.exists(file_path):
18
+ raise FileNotFoundError(f"Extension file not found at path: {file_path}")
19
+
20
+ response = await self._client.transport.post(
21
+ self._client._build_url("/extensions/add"),
22
+ data=(
23
+ {}
24
+ if params is None
25
+ else params.model_dump(exclude_none=True, by_alias=True)
26
+ ),
27
+ files={"file": open(file_path, "rb")},
28
+ )
29
+ return ExtensionResponse(**response.data)
30
+
31
+ async def list(self) -> List[ExtensionResponse]:
32
+ response = await self._client.transport.get(
33
+ self._client._build_url("/extensions/list"),
34
+ )
35
+ if not isinstance(response.data, list):
36
+ raise HyperbrowserError(
37
+ f"Expected list response but got {type(response.data)}",
38
+ original_error=None,
39
+ )
40
+ return [ExtensionResponse(**extension) for extension in response.data]
@@ -0,0 +1,25 @@
1
+ from hyperbrowser.models.profile import ProfileResponse, CreateProfileResponse
2
+ from hyperbrowser.models.session import BasicResponse
3
+
4
+
5
+ class ProfileManager:
6
+ def __init__(self, client):
7
+ self._client = client
8
+
9
+ async def create(self) -> CreateProfileResponse:
10
+ response = await self._client.transport.post(
11
+ self._client._build_url("/profile"),
12
+ )
13
+ return CreateProfileResponse(**response.data)
14
+
15
+ async def get(self, id: str) -> ProfileResponse:
16
+ response = await self._client.transport.get(
17
+ self._client._build_url(f"/profile/{id}"),
18
+ )
19
+ return ProfileResponse(**response.data)
20
+
21
+ async def delete(self, id: str) -> BasicResponse:
22
+ response = await self._client.transport.delete(
23
+ self._client._build_url(f"/profile/{id}"),
24
+ )
25
+ return BasicResponse(**response.data)
@@ -16,7 +16,11 @@ class SessionManager:
16
16
  async def create(self, params: CreateSessionParams = None) -> SessionDetail:
17
17
  response = await self._client.transport.post(
18
18
  self._client._build_url("/session"),
19
- data={} if params is None else params.model_dump(exclude_none=True, by_alias=True),
19
+ data=(
20
+ {}
21
+ if params is None
22
+ else params.model_dump(exclude_none=True, by_alias=True)
23
+ ),
20
24
  )
21
25
  return SessionDetail(**response.data)
22
26
 
@@ -0,0 +1,40 @@
1
+ import os
2
+ from typing import List
3
+
4
+ from hyperbrowser.exceptions import HyperbrowserError
5
+ from hyperbrowser.models.extension import CreateExtensionParams, ExtensionResponse
6
+
7
+
8
+ class ExtensionManager:
9
+ def __init__(self, client):
10
+ self._client = client
11
+
12
+ def create(self, params: CreateExtensionParams) -> ExtensionResponse:
13
+ file_path = params.file_path
14
+ params.file_path = None
15
+
16
+ # Check if file exists before trying to open it
17
+ if not os.path.exists(file_path):
18
+ raise FileNotFoundError(f"Extension file not found at path: {file_path}")
19
+
20
+ response = self._client.transport.post(
21
+ self._client._build_url("/extensions/add"),
22
+ data=(
23
+ {}
24
+ if params is None
25
+ else params.model_dump(exclude_none=True, by_alias=True)
26
+ ),
27
+ files={"file": open(file_path, "rb")},
28
+ )
29
+ return ExtensionResponse(**response.data)
30
+
31
+ def list(self) -> List[ExtensionResponse]:
32
+ response = self._client.transport.get(
33
+ self._client._build_url("/extensions/list"),
34
+ )
35
+ if not isinstance(response.data, list):
36
+ raise HyperbrowserError(
37
+ f"Expected list response but got {type(response.data)}",
38
+ original_error=None,
39
+ )
40
+ return [ExtensionResponse(**extension) for extension in response.data]
@@ -0,0 +1,25 @@
1
+ from hyperbrowser.models.profile import ProfileResponse, CreateProfileResponse
2
+ from hyperbrowser.models.session import BasicResponse
3
+
4
+
5
+ class ProfileManager:
6
+ def __init__(self, client):
7
+ self._client = client
8
+
9
+ def create(self) -> CreateProfileResponse:
10
+ response = self._client.transport.post(
11
+ self._client._build_url("/profile"),
12
+ )
13
+ return CreateProfileResponse(**response.data)
14
+
15
+ def get(self, id: str) -> ProfileResponse:
16
+ response = self._client.transport.get(
17
+ self._client._build_url(f"/profile/{id}"),
18
+ )
19
+ return ProfileResponse(**response.data)
20
+
21
+ def delete(self, id: str) -> BasicResponse:
22
+ response = self._client.transport.delete(
23
+ self._client._build_url(f"/profile/{id}"),
24
+ )
25
+ return BasicResponse(**response.data)
@@ -16,7 +16,11 @@ class SessionManager:
16
16
  def create(self, params: CreateSessionParams = None) -> SessionDetail:
17
17
  response = self._client.transport.post(
18
18
  self._client._build_url("/session"),
19
- data={} if params is None else params.model_dump(exclude_none=True, by_alias=True),
19
+ data=(
20
+ {}
21
+ if params is None
22
+ else params.model_dump(exclude_none=True, by_alias=True)
23
+ ),
20
24
  )
21
25
  return SessionDetail(**response.data)
22
26
 
@@ -1,7 +1,9 @@
1
1
  from typing import Optional
2
+ from .managers.sync_manager.profile import ProfileManager
2
3
  from .managers.sync_manager.session import SessionManager
3
4
  from .managers.sync_manager.scrape import ScrapeManager
4
5
  from .managers.sync_manager.crawl import CrawlManager
6
+ from .managers.sync_manager.extension import ExtensionManager
5
7
  from .base import HyperbrowserBase
6
8
  from ..transport.sync import SyncTransport
7
9
  from ..config import ClientConfig
@@ -15,11 +17,15 @@ class Hyperbrowser(HyperbrowserBase):
15
17
  config: Optional[ClientConfig] = None,
16
18
  api_key: Optional[str] = None,
17
19
  base_url: Optional[str] = None,
20
+ timeout: Optional[int] = 30,
18
21
  ):
19
22
  super().__init__(SyncTransport, config, api_key, base_url)
23
+ self.transport.client.timeout = timeout
20
24
  self.sessions = SessionManager(self)
21
25
  self.scrape = ScrapeManager(self)
22
26
  self.crawl = CrawlManager(self)
27
+ self.profiles = ProfileManager(self)
28
+ self.extensions = ExtensionManager(self)
23
29
 
24
30
  def close(self) -> None:
25
31
  self.transport.close()
@@ -1,6 +1,6 @@
1
1
  from typing import Literal
2
2
 
3
- ScrapeFormat = Literal["markdown", "html", "links"]
3
+ ScrapeFormat = Literal["markdown", "html", "links", "screenshot"]
4
4
 
5
5
  Country = Literal[
6
6
  "AD",
@@ -0,0 +1,27 @@
1
+ from datetime import datetime
2
+ from typing import List, Literal, Optional
3
+ from pydantic import BaseModel, ConfigDict, Field
4
+
5
+
6
+ class CreateExtensionParams(BaseModel):
7
+ """
8
+ Parameters for creating a new extension.
9
+ """
10
+
11
+ model_config = ConfigDict(
12
+ populate_by_alias=True,
13
+ )
14
+
15
+ name: Optional[str] = Field(default=None, serialization_alias="name")
16
+ file_path: str = Field(serialization_alias="filePath")
17
+
18
+
19
+ class ExtensionResponse(BaseModel):
20
+ model_config = ConfigDict(
21
+ populate_by_alias=True,
22
+ )
23
+
24
+ id: str = Field(serialization_alias="id")
25
+ name: str = Field(serialization_alias="name")
26
+ created_at: datetime = Field(serialization_alias="createdAt", alias="createdAt")
27
+ updated_at: datetime = Field(serialization_alias="updatedAt", alias="updatedAt")
@@ -0,0 +1,17 @@
1
+ from pydantic import BaseModel, ConfigDict, Field
2
+ from datetime import datetime
3
+
4
+
5
+ class CreateProfileResponse(BaseModel):
6
+ id: str
7
+
8
+
9
+ class ProfileResponse(BaseModel):
10
+ model_config = ConfigDict(
11
+ populate_by_alias=True,
12
+ )
13
+
14
+ id: str
15
+ team_id: str = Field(alias="teamId")
16
+ created_at: datetime = Field(alias="createdAt")
17
+ updated_at: datetime = Field(alias="updatedAt")
@@ -101,6 +101,17 @@ class ScreenConfig(BaseModel):
101
101
  height: int = Field(default=720, serialization_alias="height")
102
102
 
103
103
 
104
+ class CreateSessionProfile(BaseModel):
105
+ """
106
+ Profile configuration parameters for browser session.
107
+ """
108
+
109
+ id: Optional[str] = Field(default=None, serialization_alias="id")
110
+ persist_changes: Optional[bool] = Field(
111
+ default=None, serialization_alias="persistChanges"
112
+ )
113
+
114
+
104
115
  class CreateSessionParams(BaseModel):
105
116
  """
106
117
  Parameters for creating a new browser session.
@@ -134,7 +145,11 @@ class CreateSessionParams(BaseModel):
134
145
  trackers: bool = Field(default=False, serialization_alias="trackers")
135
146
  annoyances: bool = Field(default=False, serialization_alias="annoyances")
136
147
  enable_web_recording: Optional[bool] = Field(
137
- default=False, serialization_alias="enableWebRecording"
148
+ default=True, serialization_alias="enableWebRecording"
149
+ )
150
+ profile: Optional[CreateSessionProfile] = Field(default=None)
151
+ extension_ids: Optional[List[str]] = Field(
152
+ default=None, serialization_alias="extensionIds"
138
153
  )
139
154
 
140
155
 
@@ -66,9 +66,14 @@ class AsyncTransport(TransportStrategy):
66
66
  except httpx.RequestError as e:
67
67
  raise HyperbrowserError("Request failed", original_error=e)
68
68
 
69
- async def post(self, url: str, data: Optional[dict] = None) -> APIResponse:
69
+ async def post(
70
+ self, url: str, data: Optional[dict] = None, files: Optional[dict] = None
71
+ ) -> APIResponse:
70
72
  try:
71
- response = await self.client.post(url, json=data)
73
+ if files:
74
+ response = await self.client.post(url, data=data, files=files)
75
+ else:
76
+ response = await self.client.post(url, json=data)
72
77
  return await self._handle_response(response)
73
78
  except HyperbrowserError:
74
79
  raise
@@ -94,3 +99,12 @@ class AsyncTransport(TransportStrategy):
94
99
  raise
95
100
  except Exception as e:
96
101
  raise HyperbrowserError("Put request failed", original_error=e)
102
+
103
+ async def delete(self, url: str) -> APIResponse:
104
+ try:
105
+ response = await self.client.delete(url)
106
+ return await self._handle_response(response)
107
+ except HyperbrowserError:
108
+ raise
109
+ except Exception as e:
110
+ raise HyperbrowserError("Delete request failed", original_error=e)
@@ -55,3 +55,7 @@ class TransportStrategy(ABC):
55
55
  @abstractmethod
56
56
  def put(self, url: str) -> APIResponse:
57
57
  pass
58
+
59
+ @abstractmethod
60
+ def delete(self, url: str) -> APIResponse:
61
+ pass
@@ -45,9 +45,14 @@ class SyncTransport(TransportStrategy):
45
45
  def close(self) -> None:
46
46
  self.client.close()
47
47
 
48
- def post(self, url: str, data: Optional[dict] = None) -> APIResponse:
48
+ def post(
49
+ self, url: str, data: Optional[dict] = None, files: Optional[dict] = None
50
+ ) -> APIResponse:
49
51
  try:
50
- response = self.client.post(url, json=data)
52
+ if files:
53
+ response = self.client.post(url, data=data, files=files)
54
+ else:
55
+ response = self.client.post(url, json=data)
51
56
  return self._handle_response(response)
52
57
  except HyperbrowserError:
53
58
  raise
@@ -73,3 +78,12 @@ class SyncTransport(TransportStrategy):
73
78
  raise
74
79
  except Exception as e:
75
80
  raise HyperbrowserError("Put request failed", original_error=e)
81
+
82
+ def delete(self, url: str) -> APIResponse:
83
+ try:
84
+ response = self.client.delete(url)
85
+ return self._handle_response(response)
86
+ except HyperbrowserError:
87
+ raise
88
+ except Exception as e:
89
+ raise HyperbrowserError("Delete request failed", original_error=e)
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "hyperbrowser"
3
- version = "0.10.0"
3
+ version = "0.12.0"
4
4
  description = "Python SDK for hyperbrowser"
5
5
  authors = ["Nikhil Shahi <nshahi1998@gmail.com>"]
6
6
  license = "MIT"
File without changes