s/zen/client

Author: Alex Schworer

README.md

@@ -31,16 +31,16 @@ Create an instance of the Zencoder client. This will accept an API key and versi
 Create a [new job](https://app.zencoder.com/docs/api/jobs/create).
 
 ```python
-zen.job.create('s3://bucket/key.mp4')
-zen.job.create('s3://bucket/key.mp4',
+client.job.create('s3://bucket/key.mp4')
+client.job.create('s3://bucket/key.mp4',
                outputs=[{'label': 'vp8 for the web',
                          'url': 's3://bucket/key_output.webm'}])
 ```
 
 This returns a `zencoder.Response` object. The body includes a Job ID, and one or more Output IDs (one for every output file created).
 
 ```python
-response = zen.job.create('s3://bucket/key.mp4')
+response = client.job.create('s3://bucket/key.mp4')
 response.code           # 201
 response.body['id']     # 12345
 ```
@@ -50,39 +50,40 @@ response.body['id']     # 12345
 By default the jobs listing is paginated with 50 jobs per page and sorted by ID in descending order. You can pass two parameters to control the paging: `page` and `per_page`.
 
 ```python
-zen.job.list(per_page=10)
-zen.job.list(per_page=10, page=2)
+client.job.list(per_page=10)
+client.job.list(per_page=10, page=2)
 ```
 
 Get [details](https://app.zencoder.com/docs/api/jobs/show) about a job.
 
 The number passed to `details` is the ID of a Zencoder job.
 
 ```python
-zen.job.details(1)
+client.job.details(1)
 ```
 
 Get [progress](https://app.zencoder.com/docs/api/jobs/progress) on a job.
 
 The number passed to `progress` is the ID of a Zencoder job.
 
 ```python
-zen.job.progress(1)
+client.job.progress(1)
 ```
 
 [Resubmit](https://app.zencoder.com/docs/api/jobs/resubmit) a job
 
 The number passed to `resubmit` is the ID of a Zencoder job.
 
 ```python
-zen.job.resubmit(1)
+client.job.resubmit(1)
 ```
 
 [Cancel](https://app.zencoder.com/docs/api/jobs/cancel) a job
 
 The number passed to `cancel` is the ID of a Zencoder job.
 
 ```python
+client.job.cancel(1)
 ```
 
 ## [Inputs](https://app.zencoder.com/docs/api/inputs)
@@ -92,15 +93,15 @@ Get [details](https://app.zencoder.com/docs/api/inputs/show) about an input.
 The number passed to `details` is the ID of a Zencoder job.
 
 ```python
-zen.input.details(1)
+client.input.details(1)
 ```
 
 Get [progress](https://app.zencoder.com/docs/api/inputs/progress) for an input.
 
 The number passed to `progress` is the ID of a Zencoder job.
 
 ```python
-zen.input.progress(1)
+client.input.progress(1)
 ```
 
 ## [Outputs](https://app.zencoder.com/docs/api/outputs)
@@ -110,15 +111,15 @@ Get [details](https://app.zencoder.com/docs/api/outputs/show) about an output.
 The number passed to `details` is the ID of a Zencoder job.
 
 ```python
-zen.output.details(1)
+client.output.details(1)
 ```
 
 Get [progress](https://app.zencoder.com/docs/api/outputs/progress) for an output.
 
 The number passed to `progress` is the ID of a Zencoder job.
 
 ```python
-zen.output.progress(1)
+client.output.progress(1)
 ```
 
 ## [Reports](https://app.zencoder.com/docs/api/reports)
@@ -129,11 +130,11 @@ Get [all usage](https://app.zencoder.com/docs/api/reports/all) (Live + VOD).
 
 ```python
 import datetime
-zen.report.all()
-zen.report.all(grouping="foo")
-zen.report.all(start_date=datetime.date(2011, 10, 30),
+client.report.all()
+client.report.all(grouping="foo")
+client.report.all(start_date=datetime.date(2011, 10, 30),
                 end_date=datetime.date(2011, 11, 24))
-zen.report.all(start_date=datetime.date(2011, 10, 30),
+client.report.all(start_date=datetime.date(2011, 10, 30),
                 end_date=datetime.date(2011, 11, 24),
                 grouping="foo")
 ```
@@ -142,11 +143,11 @@ Get [VOD usage](https://app.zencoder.com/docs/api/reports/vod).
 
 ```python
 import datetime
-zen.report.vod()
-zen.report.vod(grouping="foo")
-zen.report.vod(start_date=datetime.date(2011, 10, 30),
+client.report.vod()
+client.report.vod(grouping="foo")
+client.report.vod(start_date=datetime.date(2011, 10, 30),
                end_date=datetime.date(2011, 11, 24))
-zen.report.vod(start_date=datetime.date(2011, 10, 30),
+client.report.vod(start_date=datetime.date(2011, 10, 30),
                end_date=datetime.date(2011, 11, 24),
                grouping="foo")
 ```
@@ -155,11 +156,11 @@ Get [Live usage](https://app.zencoder.com/docs/api/reports/live).
 
 ```python
 import datetime
-zen.report.live()
-zen.report.live(grouping="foo")
-zen.report.live(start_date=datetime.date(2011, 10, 30),
+client.report.live()
+client.report.live(grouping="foo")
+client.report.live(start_date=datetime.date(2011, 10, 30),
                 end_date=datetime.date(2011, 11, 24))
-zen.report.live(start_date=datetime.date(2011, 10, 30),
+client.report.live(start_date=datetime.date(2011, 10, 30),
                 end_date=datetime.date(2011, 11, 24),
                 grouping="foo")
 ```
@@ -171,28 +172,28 @@ Create a [new account](https://app.zencoder.com/docs/api/accounts/create). A uni
 No API Key is required.
 
 ```python
-zen.account.create('foo@example.com', tos=1)
-zen.account.create('foo@example.com', tos=1,
+client.account.create('foo@example.com', tos=1)
+client.account.create('foo@example.com', tos=1,
                    options={'password': 'abcd1234',
                             'affiliate_code': 'foo'})
 ```
 
 Get [details](https://app.zencoder.com/docs/api/accounts/show) about the current account.
 
 ```python
-zen.account.details()
+client.account.details()
 ```
 
 Turn [integration mode](https://app.zencoder.com/docs/api/accounts/integration) on (all jobs are test jobs).
 
 ```python
-zen.account.integration()
+client.account.integration()
 ```
 
 Turn off integration mode, which means your account is live (and you'll be billed for jobs).
 
 ```python
-zen.account.live()
+client.account.live()
 ```
 ## Tests