Skip to main content

Python bindings for the Plex API.

Project description

## PlexAPI ##
Python bindings for the Plex API.

* Navigate your Plex library.
* Mark shows watched or unwatched.
* Request rescan, analyze, empty trash.
* Play media on connected clients.

Planned features:

* Create and maintain playlists.
* Use API from another network.
* Navigate shared libraries.
* List active sessions.
* Play trailers and extras.
* Provide useful utility scripts.
* Better support for Music and Photos?

#### Install ###

pip install plexapi

#### Examples ####

from plexapi.myplex import MyPlexUser

user = MyPlexUser(args.username, args.password)
plex = user.getServer(args.server).connect()

# Example 1: List all unwatched content in library.
for section in plex.library.sections():
print 'Unwatched content in %s:' % section.title
for video in section.unwatched():
print ' %s' % video.title

# Example 2: Mark all Conan episodes watched.
plex.library.get('Conan (2010)').markWatched()

# Example 3: List all Clients connected to the Server.
for client in plex.clients():
print client.name

# Example 4: Play the Movie Avatar on my iPhone.
avatar = plex.library.section('Movies').get('Avatar')
client = plex.client("Michael's iPhone")
client.playMedia(avatar)

# Example 5: List all content with the word 'Game' in the title.
for video in plex.search('Game'):
print '%s (%s)' % (video.title, video.TYPE)

# Example 6: List all movies directed by the same person as Jurassic Park.
jurassic_park = plex.library.section('Movies').get('Jurassic Park')
director = jurassic_park.directors[0]
for movie in director.related():
print movie.title

# Example 7: List files for the latest episode of Friends.
the_last_one = plex.library.get('Friends').episodes()[-1]
for part in the_last_one.iter_parts():
print part.file

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PlexAPI-0.9.3.tar.gz (15.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page