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.server import PlexServer
server = PlexServer()

# Example 1: List all unwatched content in library.
for section in server.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.
server.library.get('Conan (2010)').markWatched()

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

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

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

# Example 6: List all movies directed by the same person as Jurassic Park.
jurassic_park = server.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 = server.library.get('Friends').episodes()[-1]
for part in the_last_one.iter_parts():
print part.file

Project details


Release history Release notifications | RSS feed

This version

0.9.2

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.2.tar.gz (10.1 kB view details)

Uploaded Source

File details

Details for the file PlexAPI-0.9.2.tar.gz.

File metadata

  • Download URL: PlexAPI-0.9.2.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for PlexAPI-0.9.2.tar.gz
Algorithm Hash digest
SHA256 fb1341593ff32aa9cd3bec91910e6f2eb8c759e94f1220e56f0fff539a7543f7
MD5 aa1bf14e2ef35b92e55e3ff4c6f3dd66
BLAKE2b-256 9e939b700c5cb93b0a6c4ae6f27b9f900e79c2ef0d8dbb6cca4343e1aac17182

See more details on using hashes here.

Supported by

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