Mirrors/python-plexapi
2
0
Fork 0
mirror of https://github.com/pkkid/python-plexapi synced 2024-11-26 05:30:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add syntax highlighting to readme

Browse source
This commit is contained in:
Michael Shepanski 2015-06-04 11:26:42 -04:00
parent 05ef43bddc
commit d1ae065d68
1 changed files with 37 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -26,8 +26,10 @@ network as the Plex Server (and you are not using Plex Users), you can
authenticate without a username and password. Getting a PlexServer authenticate without a username and password. Getting a PlexServer
instance is as easy as the following: instance is as easy as the following:
from plexapi.server import PlexServer ```python
plex = PlexServer() # Defaults to localhost:32400 from plexapi.server import PlexServer
plex = PlexServer() # Defaults to localhost:32400
```
If you are running on a separate network or using Plex Users you need to log If you are running on a separate network or using Plex Users you need to log
into MyPlex to get a PlexServer instance. An example of this is below. NOTE: into MyPlex to get a PlexServer instance. An example of this is below. NOTE:
@ -35,44 +37,48 @@ Servername below is the name of the server (not the hostname and port). If
logged into Plex Web you can see the server name in the top left above your logged into Plex Web you can see the server name in the top left above your
available libraries. available libraries.
from plexapi.myplex import MyPlexUser ```python
user = MyPlexUser.signin('<USERNAME>', '<PASSWORD>') from plexapi.myplex import MyPlexUser
plex = user.getServer('<SERVERNAME>').connect() user = MyPlexUser.signin('<USERNAME>', '<PASSWORD>')
plex = user.getServer('<SERVERNAME>').connect()
```
#### Usage Examples #### #### Usage Examples ####
# Example 1: List all unwatched content in library. ```python
for section in plex.library.sections(): # Example 1: List all unwatched content in library.
print('Unwatched content in %s:' % section.title) for section in plex.library.sections():
for video in section.unwatched(): print('Unwatched content in %s:' % section.title)
print(' %s' % video.title) for video in section.unwatched():
print(' %s' % video.title)
# Example 2: Mark all Conan episodes watched. # Example 2: Mark all Conan episodes watched.
plex.library.get('Conan (2010)').markWatched() plex.library.get('Conan (2010)').markWatched()
# Example 3: List all Clients connected to the Server. # Example 3: List all Clients connected to the Server.
for client in plex.clients(): for client in plex.clients():
print(client.name) print(client.name)
# Example 4: Play the Movie Avatar on my iPhone. # Example 4: Play the Movie Avatar on my iPhone.
avatar = plex.library.section('Movies').get('Avatar') avatar = plex.library.section('Movies').get('Avatar')
client = plex.client("Michael's iPhone") client = plex.client("Michael's iPhone")
client.playMedia(avatar) client.playMedia(avatar)
# Example 5: List all content with the word 'Game' in the title. # Example 5: List all content with the word 'Game' in the title.
for video in plex.search('Game'): for video in plex.search('Game'):
print('%s (%s)' % (video.title, video.TYPE)) print('%s (%s)' % (video.title, video.TYPE))
# Example 6: List all movies directed by the same person as Jurassic Park. # Example 6: List all movies directed by the same person as Jurassic Park.
jurassic_park = plex.library.section('Movies').get('Jurassic Park') jurassic_park = plex.library.section('Movies').get('Jurassic Park')
director = jurassic_park.directors[0] director = jurassic_park.directors[0]
for movie in director.related(): for movie in director.related():
print(movie.title) print(movie.title)
# Example 7: List files for the latest episode of Friends. # Example 7: List files for the latest episode of Friends.
the_last_one = plex.library.get('Friends').episodes()[-1] the_last_one = plex.library.get('Friends').episodes()[-1]
for part in the_last_one.iter_parts(): for part in the_last_one.iter_parts():
print(part.file) print(part.file)
```
#### FAQs #### #### FAQs ####