Skip to content

README should use python codeblocks #16

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
josiasmontag merged 1 commit into from
Sep 1, 2021
Merged

README should use python codeblocks #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,23 @@ For API v1, please use [v1 branch](https://github.com/cloudconvert/cloudconvert-

## Creating API Client

```
import cloudconvert
cloudconvert.configure(api_key = 'API_KEY', sandbox = False)
```py
import cloudconvert

cloudconvert.configure(api_key = 'API_KEY', sandbox = False)
```

Or set the environment variable `CLOUDCONVERT_API_KEY` and use:

```
import cloudconvert
cloudconvert.default()
```py
import cloudconvert

cloudconvert.default()
```

## Creating Jobs

```js
```py
import cloudconvert

cloudconvert.configure(api_key = 'API_KEY')
Expand Down Expand Up @@ -61,7 +61,7 @@ Or set the environment variable `CLOUDCONVERT_API_KEY` and use:

CloudConvert can generate public URLs for using `export/url` tasks. You can use these URLs to download output files.

```js
```py
exported_url_task_id = "84e872fc-d823-4363-baab-eade2e05ee54"
res = cloudconvert.Task.wait(id=exported_url_task_id) # Wait for job completion
file = res.get("result").get("files")[0]
Expand All @@ -73,7 +73,7 @@ print(res)

Uploads to CloudConvert are done via `import/upload` tasks (see the [docs](https://cloudconvert.com/api/v2/import#import-upload-tasks)). This SDK offers a convenient upload method:

```js
```py
job = cloudconvert.Job.create(payload={
'tasks': {
'upload-my-file': {
Expand All @@ -93,7 +93,7 @@ res = cloudconvert.Task.find(id=upload_task_id)

The node SDK allows to verify webhook requests received from CloudConvert.

```js
```py
payloadString = '...'; # The JSON string from the raw request body.
signature = '...'; # The value of the "CloudConvert-Signature" header.
signingSecret = '...'; # You can find it in your webhook settings.
Expand Down