Skip to content

Commit

Permalink
Enforced 78-char width for README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Simbul committed Dec 1, 2009
1 parent 7cdc8bd commit 5ee78e6
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,37 @@ Pymeo

Pymeo is a Python wrapper for version 2 of the Vimeo APIs.

The goal of Pymeo is to provide an abstraction over the APIs which is both consistent and easy to use.
The goal of Pymeo is to provide an abstraction over the APIs which is both
consistent and easy to use.

Consistency comes from the fact that Pymeo exposes a single interface, whereas Vimeo offers two: a simple API and an advanced API.
The interface of Pymeo is based on the advanced API, which is more developer-friendly and consistent (not to mention more powerful).
Pymeo is nonetheless able to use both APIs: in fact, the simple API is automatically used when OAuth data (i.e. consumer key and consumer secret) is not provided.
Consistency comes from the fact that Pymeo exposes a single interface, whereas
Vimeo offers two: a simple API and an advanced API.
The interface of Pymeo is based on the advanced API, which is more
developer-friendly and consistent (not to mention more powerful).
Pymeo is nonetheless able to use both APIs: in fact, the simple API is
automatically used when OAuth data (i.e. consumer key and consumer secret) is
not provided.

Ease of use comes from the introduction of methods and classes which are on a higher level than the ones exposed by the Vimeo APIs. See USING FEEDS.
Ease of use comes from the introduction of methods and classes which are on a
higher level than the ones exposed by the Vimeo APIs. See USING FEEDS.

Pymeo is licensed under the v3 of the LGPL.

===========
USING FEEDS
===========
The feed is the basic concept when retrieving a list of items (e.g. the list of all the uploaded videos for a user).
The feed is the basic concept when retrieving a list of items (e.g. the list
of all the uploaded videos for a user).
A feed can be retrieved by using the Pymeo.get_feed() method.

A feed is basically the representation of a "page" in a Vimeo API response. A single call to the Vimeo API cannot return more than 50 items[1]. That is, the output from the Vimeo API is divided in pages with a maximum length of 50 items.
A feed is basically the representation of a "page" in a Vimeo API response. A
single call to the Vimeo API cannot return more than 50 items[1]. That is, the
output from the Vimeo API is divided in pages with a maximum length of 50
items.
To get more than 50 items it is necessary to perform more than one call.

Here's an example of how to print the titles of all the uploaded videos for a sample user called 'someuser':
Here's an example of how to print the titles of all the uploaded videos for a
sample user called 'someuser':

pm = Pymeo(CONSUMER_KEY, CONSUMER_SECRET)
feed = pm.get_feed('videos.getUploads', {'user_id': 'someuser'})
Expand All @@ -34,7 +45,8 @@ Here's an example of how to print the titles of all the uploaded videos for a sa
============
KNOWN ISSUES
============
Pymeo is still in an early phase of development, and it's missing many functionalities of the Vimeo API - most notably the support for video uploads.
Pymeo is still in an early phase of development, and it's missing many
functionalities of the Vimeo API - most notably the support for video uploads.


___
Expand Down

0 comments on commit 5ee78e6

Please sign in to comment.