Skip to content

Commit 1272c9d

Browse files
committed
docs: Format with prettier
1 parent 2d19aed commit 1272c9d

File tree

4 files changed

+63
-60
lines changed

4 files changed

+63
-60
lines changed

README.md

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
## qencode-api-python-client
22

3-
43
**install sdk libraries from github**
54

6-
````
5+
```
76
cd your-workspace-folder
87
git clone https://github.com/qencode-dev/qencode-api-python-client
98
cd qencode-api-python-client
109
pip install -r requirements.txt
1110
python setup.py install
12-
````
11+
```
12+
1313
**install from pip**
1414

15-
````
15+
```
1616
sudo pip install qencode
17-
````
17+
```
1818

1919
**Usage**
2020

21-
````
21+
```
2222
import qencode
2323
2424
client = qencode.client(API_KEY)
@@ -31,7 +31,7 @@ task.start(TRANSCODING_PROFILEID, VIDEO_URL)
3131
#getting video metadata:
3232
metadata = client.get_metadata(VIDEO_URL)
3333
34-
````
34+
```
3535

3636
**Documentation**
3737

@@ -44,38 +44,41 @@ Inside this library, you will find sample code for creating [video transcoding](
4444
Some of the options Qencode offers for transcoding your videos at scale:
4545

4646
Resolution
47-
* 8K
48-
* 4K
49-
* 1440p
50-
* 1080p
51-
* 720p
52-
* 480p
53-
* 360p
54-
* 240
55-
56-
Features
57-
* Thumbnails
58-
* Watermarking
59-
* VR / 360 Encoding
60-
* Subtitles & Captions
61-
* Create Clips
62-
* Video Stitching
63-
* S3 Storage
64-
* Preview Images
65-
* Custom Resolution
66-
* Callback URLs
67-
* Custom Presets
68-
* Rotate
69-
* Aspect Ratio
70-
* Notifications
71-
* Crop Videos
47+
48+
- 8K
49+
- 4K
50+
- 1440p
51+
- 1080p
52+
- 720p
53+
- 480p
54+
- 360p
55+
- 240
56+
57+
Features
58+
59+
- Thumbnails
60+
- Watermarking
61+
- VR / 360 Encoding
62+
- Subtitles & Captions
63+
- Create Clips
64+
- Video Stitching
65+
- S3 Storage
66+
- Preview Images
67+
- Custom Resolution
68+
- Callback URLs
69+
- Custom Presets
70+
- Rotate
71+
- Aspect Ratio
72+
- Notifications
73+
- Crop Videos
7274

7375
Transfer & Storage Options
74-
* S3 Qencode
75-
* AWS
76-
* Google Cloud
77-
* Backblaze
78-
* Azure
79-
* FTP
80-
* HTTP(S)
81-
* VPN
76+
77+
- S3 Qencode
78+
- AWS
79+
- Google Cloud
80+
- Backblaze
81+
- Azure
82+
- FTP
83+
- HTTP(S)
84+
- VPN

docs/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
**install sdk libraries from github**
44

5-
````
5+
```
66
cd your-workspace-folder
77
git clone https://github.com/qencode-dev/qencode-api-python-client
88
cd qencode-api-python-client
99
pip install -r requirements.txt
1010
python setup.py install
11-
````
11+
```
1212

1313
**install from pip**
1414

15-
````
15+
```
1616
sudo pip install qencode
17-
````
17+
```

docs/quickstart.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
**install sdk libraries from github**
44

5-
````
5+
```
66
cd your-workspace-folder
77
git clone https://github.com/qencode-dev/qencode-api-python-client
88
cd qencode-api-python-client
99
pip install -r requirements.txt
1010
python setup.py install
11-
````
11+
```
1212

1313
**install from pip**
1414

15-
````
15+
```
1616
sudo pip install qencode
17-
````
17+
```
1818

1919
**Usage**
2020

21-
````
21+
```
2222
import qencode
2323
2424
client = qencode.client(API_KEY)
@@ -27,9 +27,8 @@ client.create()
2727
task = client.create_task()
2828
task.start(TRANSCODING_PROFILEID, VIDO_URL)
2929
30-
````
31-
30+
```
3231

3332
**Documentation**
3433

35-
Documentation is available at <https://docs.qencode.com>
34+
Documentation is available at <https://docs.qencode.com>

docs/usage.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Usage by transcoding profile ID**
44

5-
````
5+
```
66
import sys
77
import os.path
88
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir)))
@@ -57,11 +57,11 @@ def start_encode():
5757
5858
if __name__ == '__main__':
5959
start_encode()
60-
````
60+
```
6161

6262
**Usage by custom parameters**
6363

64-
````
64+
```
6565
import sys
6666
import os.path
6767
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir)))
@@ -144,25 +144,26 @@ def start_encode():
144144
145145
if __name__ == '__main__':
146146
start_encode()
147-
````
147+
```
148+
148149
**Usage with callback methods**
149150

150-
````
151+
```
151152
def my_callback(e):
152153
print e
153154
154155
def my_callback2(e):
155156
print e
156-
157+
157158
...
158159
159160
task.start(TRANSCODING_PROFILEID, VIDO_URL)
160-
if task.error:
161+
if task.error:
161162
raise SystemExit
162163
163164
task.progress_changed(my_callback)
164165
task.task_completed(my_callback2)
165-
````
166+
```
166167

167168
**Documentation**
168169

0 commit comments

Comments
 (0)