Skip to content

Commit 813162d

Browse files
Add markdownlint
1 parent 329e32a commit 813162d

2 files changed

Lines changed: 32 additions & 1 deletion

File tree

.markdownlint.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"first-line-h1": false,
3+
"line-length": false,
4+
"no-duplicate-heading": {
5+
"siblings_only": true
6+
},
7+
"no-inline-html": false
8+
}

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,10 @@ The main class for executing code in YepCode's runtime environment.
205205
Executes code in YepCode's runtime environment.
206206

207207
**Parameters:**
208+
208209
- `code`: Source code to execute (string)
209210
- `options`: Execution options (optional)
211+
210212
```python
211213
{
212214
"language": Optional[str], # 'javascript' or 'python'
@@ -227,6 +229,7 @@ Executes code in YepCode's runtime environment.
227229
Retrieves an existing execution by ID.
228230

229231
**Parameters:**
232+
230233
- `execution_id`: Unique identifier for the execution
231234

232235
**Returns:** Execution
@@ -236,6 +239,7 @@ Retrieves an existing execution by ID.
236239
Represents a code execution instance.
237240

238241
**Properties:**
242+
239243
```python
240244
class Execution:
241245
id: str # Unique identifier
@@ -252,21 +256,25 @@ class Execution:
252256
**Methods:**
253257

254258
###### `is_done() -> bool`
259+
255260
Returns whether the execution has completed.
256261

257262
**Returns:** bool
258263

259264
###### `wait_for_done() -> None`
265+
260266
Waits for the execution to complete.
261267

262268
**Returns:** None
263269

264270
###### `kill() -> None`
271+
265272
Terminates the execution.
266273

267274
**Returns:** None
268275

269276
###### `rerun() -> Execution`
277+
270278
Creates a new execution with the same configuration.
271279

272280
**Returns:** Execution
@@ -278,9 +286,11 @@ Manages environment variables for your YepCode workspace.
278286
#### Methods
279287

280288
##### `get_env_vars() -> List[TeamVariable]`
289+
281290
Returns all environment variables.
282291

283292
**Returns:** List[TeamVariable]
293+
284294
```python
285295
class TeamVariable:
286296
key: str
@@ -289,19 +299,23 @@ class TeamVariable:
289299
```
290300

291301
##### `set_env_var(key: str, value: str, is_sensitive: bool = True) -> None`
302+
292303
Sets an environment variable.
293304

294305
**Parameters:**
306+
295307
- `key`: Variable name
296308
- `value`: Variable value
297309
- `is_sensitive`: Whether the variable contains sensitive data (defaults to true)
298310

299311
**Returns:** None
300312

301313
##### `del_env_var(key: str) -> None`
314+
302315
Deletes an environment variable.
303316

304317
**Parameters:**
318+
305319
- `key`: Variable name to delete
306320

307321
**Returns:** None
@@ -313,9 +327,11 @@ Provides direct access to the YepCode API.
313327
#### Methods
314328

315329
##### `get_processes() -> List[Process]`
330+
316331
Returns all available processes.
317332

318333
**Returns:** List[Process]
334+
319335
```python
320336
class Process:
321337
id: str
@@ -331,31 +347,38 @@ The main class for managing files in YepCode's cloud storage.
331347
#### Methods
332348

333349
##### `upload(name: str, file: bytes) -> StorageObject`
350+
334351
Uploads a file to YepCode storage.
335352

336353
**Parameters:**
354+
337355
- `name`: Name of the file in storage
338356
- `file`: File content as bytes or a file-like object
339357

340358
**Returns:** StorageObject
341359

342360
##### `download(name: str) -> bytes`
361+
343362
Downloads a file from YepCode storage.
344363

345364
**Parameters:**
365+
346366
- `name`: Name of the file to download
347367

348368
**Returns:** File content as bytes
349369

350370
##### `delete(name: str) -> None`
371+
351372
Deletes a file from YepCode storage.
352373

353374
**Parameters:**
375+
354376
- `name`: Name of the file to delete
355377

356378
**Returns:** None
357379

358380
##### `list() -> List[StorageObject]`
381+
359382
Lists all files in YepCode storage.
360383

361384
**Returns:** List of StorageObject
@@ -379,4 +402,4 @@ class CreateStorageObjectInput:
379402

380403
## License
381404

382-
All rights reserved by YepCode. This package is part of the YepCode Platform and is subject to the [YepCode Terms of Service](https://yepcode.io/terms-of-use).
405+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)