Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Update readme docs with usage#23

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
schworer merged 7 commits intomasterfromreadme-docs
Jun 6, 2013
Merged
Changes fromall commits
Commits
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
233 changes: 187 additions & 46 deletionsREADME.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,207 @@
# Zencoder

Zencoder
--------

[![Build Status](https://travis-ci.org/zencoder/zencoder-py.png?branch=master)](https://travis-ci.org/zencoder/zencoder-py)

A Python module for the [Zencoder](http://zencoder.com) API.
A Python module for interacting with the [Zencoder](http://zencoder.com) API.

### Getting Started

Install from PyPI

$ pip install zencoder

Import zencoder

```python
from zencoder import Zencoder
```

Create an instance of the Zencoder client. This will accept an API key and version. If not API key is set, it will look for a `ZENCODER_API_KEY` environment variable. API version defaults to 'v2'.

# If you want to specify an API key when creating a client
client = Zencoder('API_KEY')

# If you have the environment variable set
client = Zencoder()

## [Jobs](https://app.zencoder.com/docs/api/jobs)

Create a [new job](https://app.zencoder.com/docs/api/jobs/create).

```python
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 = client.job.create('s3://bucket/key.mp4')
response.code # 201
response.body['id'] # 12345
```

[List jobs](https://app.zencoder.com/docs/api/jobs/list).

## Installation
Install from PyPI using `easy_install` or `pip`.
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`.

pip install zencoder
```python
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
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
client.job.progress(1)
```

## Dependencies
`zencoder-py` depends on [requests](http://python-requests.org), and uses the `json` or `simplejson` module.
[Resubmit](https://app.zencoder.com/docs/api/jobs/resubmit) a job

## Usage
The number passed to `resubmit` is the ID of a Zencoder job.

from zencoder import Zencoder
zen = Zencoder('abc123') # enter your api key
```python
client.job.resubmit(1)
```

# creates an encoding job with the defaults
job = zen.job.create('http://input-file/movie.avi')
print job.code
print job.body
print job.body['id']
[Cancel](https://app.zencoder.com/docs/api/jobs/cancel) a job

# get the transcode progress of the first output
progress = zen.output.progress(job.body['outputs'][0]['id'])
print progress.body
The number passed to `cancel` is the ID of a Zencoder job.

```python
client.job.cancel(1)
```

# configure your outputs with dictionaries
iphone = {
'label': 'iPhone',
'url': 's3://output-bucket/output-file-1.mp4',
'width': 480,
'height': 320
}
web = {
'label': 'web',
'url': 's3://output-bucket/output-file.vp8',
'video_codec':, 'vp8'
}
# the outputs kwarg requires an iterable
outputs = (iphone, web)
another_job = zen.job.create(input_url, outputs=outputs)
## [Inputs](https://app.zencoder.com/docs/api/inputs)

**Note:** If you set the `ZENCODER_API_KEY` environment variable to yourapi key, you don't have to provide it when initializing Zencoder.
Get [details](https://app.zencoder.com/docs/api/inputs/show) about an input.

## Specifying the API Version
Set the version of the Zencoder API you want to use as the `api_version` keyword to the `Zencoder` object (defaults to `v2`):
The number passed to `details` is the ID of a Zencoder job.

```python
# set to version 1: https://app.zencoder.com/api/v1/
zen = Zencoder(api_version='v1')
client.input.details(1)
```

# set to the edge version: https://app.zencoder.com/api/
zen = Zencoder(api_version='edge')
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
client.input.progress(1)
```
## Documentation
Docs are in progress, and hosted at Read the Docs: http://zencoder.rtfd.org

## Contributors
* [Senko Rasic](http://github.com/senko)
* [Josh Kennedy](http://github.com/kennedyj)
* [Issac Kelly](http://github.com/issackelly)
## [Outputs](https://app.zencoder.com/docs/api/outputs)

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
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
client.output.progress(1)
```

## [Reports](https://app.zencoder.com/docs/api/reports)

Reports are great for getting usage data for your account. All default to 30 days from yesterday with no [grouping](https://app.zencoder.com/docs/api/encoding/job/grouping), but this can be altered. These will return `422 Unprocessable Entity` if the date format is incorrect or the range is greater than 2 months.

Get [all usage](https://app.zencoder.com/docs/api/reports/all) (Live + VOD).

```python
import datetime
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))
client.report.all(start_date=datetime.date(2011, 10, 30),
end_date=datetime.date(2011, 11, 24),
grouping="foo")
```

Get [VOD usage](https://app.zencoder.com/docs/api/reports/vod).

```python
import datetime
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))
client.report.vod(start_date=datetime.date(2011, 10, 30),
end_date=datetime.date(2011, 11, 24),
grouping="foo")
```

Get [Live usage](https://app.zencoder.com/docs/api/reports/live).

```python
import datetime
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))
client.report.live(start_date=datetime.date(2011, 10, 30),
end_date=datetime.date(2011, 11, 24),
grouping="foo")
```

## [Accounts](https://app.zencoder.com/docs/api/accounts)

Create a [new account](https://app.zencoder.com/docs/api/accounts/create). A unique email address and terms of service are required, but you can also specify a password (and confirmation) along with whether or not you want to subscribe to the Zencoder newsletter. New accounts will be created under the Test (Free) plan.

No API Key is required.

```python
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
client.account.details()
```

Turn [integration mode](https://app.zencoder.com/docs/api/accounts/integration) on (all jobs are test jobs).

```python
client.account.integration()
```

Turn off integration mode, which means your account is live (and you'll be billed for jobs).

```python
client.account.live()
```
## Tests

The tests use the `mock` library to stub in response data from the API. Run tests individually:

$ python test/test_jobs.py

Or use `nose`:

$ nosetests

[8]ページ先頭
©2009-2025 Movatter.jp