Skip to content

🌿 Fern Regeneration -- March 27, 2025 #45

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.

Sign up for GitHub

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

Merged
kcoopermiller merged 3 commits into from
Mar 27, 2025
Merged

🌿 Fern Regeneration -- March 27, 2025 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d8b7b4
SDK regeneration
fern-api[bot] Mar 27, 2025
6d8671e
remove old file stuff
kcoopermiller Mar 27, 2025
bd5801d
fileresponse type
kcoopermiller Mar 27, 2025
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
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "scrapybara"

[tool.poetry]
name = "scrapybara"
version = "2.4.5"
version = "2.4.6"
description = ""
readme = "README.md"
authors = []
Expand Down
299 changes: 2 additions & 297 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ client.instance.edit(
</dl>
</details>

<details><summary><code>client.instance.<a href="src/scrapybara/instance/client.py">filesystem</a>(...)</code></summary>
<details><summary><code>client.instance.<a href="src/scrapybara/instance/client.py">file</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -626,7 +626,7 @@ from scrapybara import Scrapybara
client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.instance.filesystem(
client.instance.file(
instance_id="instance_id",
command="command",
)
Expand Down Expand Up @@ -1996,301 +1996,6 @@ client.notebook.execute(
</dl>


</dd>
</dl>
</details>

## File
<details><summary><code>client.file.<a href="src/scrapybara/file/client.py">read</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from scrapybara import Scrapybara

client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.file.read(
instance_id="instance_id",
path="path",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**instance_id:** `str`

</dd>
</dl>

<dl>
<dd>

**path:** `str`

</dd>
</dl>

<dl>
<dd>

**encoding:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.file.<a href="src/scrapybara/file/client.py">write</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from scrapybara import Scrapybara

client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.file.write(
instance_id="instance_id",
path="path",
content="content",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**instance_id:** `str`

</dd>
</dl>

<dl>
<dd>

**path:** `str`

</dd>
</dl>

<dl>
<dd>

**content:** `str`

</dd>
</dl>

<dl>
<dd>

**encoding:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.file.<a href="src/scrapybara/file/client.py">upload</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from scrapybara import Scrapybara

client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.file.upload(
instance_id="instance_id",
path="path",
content="content",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**instance_id:** `str`

</dd>
</dl>

<dl>
<dd>

**path:** `str`

</dd>
</dl>

<dl>
<dd>

**content:** `str`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.file.<a href="src/scrapybara/file/client.py">download</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from scrapybara import Scrapybara

client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.file.download(
instance_id="instance_id",
path="path",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**instance_id:** `str`

</dd>
</dl>

<dl>
<dd>

**path:** `str`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down
11 changes: 3 additions & 8 deletions src/scrapybara/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
EnvGetResponse,
EnvResponse,
ExecuteCellRequest,
FileDownloadResponse,
FileReadResponse,
FilesystemResponse,
FileResponse,
GetCursorPositionAction,
GetInstanceResponse,
GetInstanceResponseInstanceType,
Expand All @@ -45,7 +43,7 @@
WaitAction,
)
from .errors import UnprocessableEntityError
from . import browser, code, env, file, instance, notebook
from . import browser, code, env, instance, notebook
from .client import AsyncScrapybara, Scrapybara
from .environment import ScrapybaraEnvironment
from .instance import (
Expand Down Expand Up @@ -82,9 +80,7 @@
"EnvGetResponse",
"EnvResponse",
"ExecuteCellRequest",
"FileDownloadResponse",
"FileReadResponse",
"FilesystemResponse",
"FileResponse",
"GetCursorPositionAction",
"GetInstanceResponse",
"GetInstanceResponseInstanceType",
Expand Down Expand Up @@ -125,7 +121,6 @@
"browser",
"code",
"env",
"file",
"instance",
"notebook",
]
4 changes: 0 additions & 4 deletions src/scrapybara/base_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
from .browser.client import BrowserClient
from .code.client import CodeClient
from .notebook.client import NotebookClient
from .file.client import FileClient
from .env.client import EnvClient
from .types.deployment_config_instance_type import DeploymentConfigInstanceType
from .core.request_options import RequestOptions
Expand All @@ -26,7 +25,6 @@
from .browser.client import AsyncBrowserClient
from .code.client import AsyncCodeClient
from .notebook.client import AsyncNotebookClient
from .file.client import AsyncFileClient
from .env.client import AsyncEnvClient

# this is used as the default value for optional parameters
Expand Down Expand Up @@ -99,7 +97,6 @@ def __init__(
self.browser = BrowserClient(client_wrapper=self._client_wrapper)
self.code = CodeClient(client_wrapper=self._client_wrapper)
self.notebook = NotebookClient(client_wrapper=self._client_wrapper)
self.file = FileClient(client_wrapper=self._client_wrapper)
self.env = EnvClient(client_wrapper=self._client_wrapper)

def start(
Expand Down Expand Up @@ -383,7 +380,6 @@ def __init__(
self.browser = AsyncBrowserClient(client_wrapper=self._client_wrapper)
self.code = AsyncCodeClient(client_wrapper=self._client_wrapper)
self.notebook = AsyncNotebookClient(client_wrapper=self._client_wrapper)
self.file = AsyncFileClient(client_wrapper=self._client_wrapper)
self.env = AsyncEnvClient(client_wrapper=self._client_wrapper)

async def start(
Expand Down
Loading