Schedule Setting¶
The script is designed to run continuously and certain attributes can be scheduled using these attributes.
Below is an example of a scheduled library:
libraries:
Movies:
schedule: weekly(sunday)
metadata_path:
- file: config/Movies.yml
- pmm: imdb
- pmm: studio
- pmm: genre
- pmm: actor
operations:
mass_critic_rating_update: tmdb
Below is an example of scheduling Metadata Files, Playlist Files, and Overlay Files:
Note: Overlay Files cannot be individually Scheduled.
libraries:
Movies:
metadata_path:
- file: config/Movies.yml
schedule: weekly(monday)
- pmm: imdb
schedule: weekly(tuesday)
- pmm: studio
schedule: weekly(wednesday)
- pmm: genre
schedule: weekly(thursday)
- pmm: actor
schedule: weekly(friday)
overlay_path:
- schedule: weekly(saturday)
- pmm: audio_codec
- pmm: resolution
- pmm: video_format
playlist_files:
- file: config/Playlists.yml
schedule: weekly(sunday)
- file: config/Playlists2.yml
schedule: weekly(monday)
Below is an example of a scheduled collection:
collections:
TMDb Trending Weekly:
tmdb_trending_weekly: 30
sync_mode: sync
schedule: weekly(sunday)
TMDb Top Rated:
tmdb_top_rated: 30
sync_mode: sync
schedule:
- monthly(1)
- monthly(15)
Below is an example of a scheduled pinning collection:
collections:
Christmas Movies:
imdb_list: https://www.imdb.com/list/ls000096828/
sync_mode: sync
visible_home: range(12/01-12/31)
The scheduling options are:
Name |
Description |
Format |
Example |
---|---|---|---|
Hourly |
Update only when the script is run in that hour |
hourly(Hour of Day) |
|
Daily |
Update once a day |
daily |
|
Weekly |
Update once a week on the specified day |
weekly(Day of Week) |
|
Monthly |
Update once a month on the specified day |
monthly(Day of Month) |
|
Yearly |
Update once a year on the specified day |
yearly(MM/DD) |
|
Range |
Updates whenever the date is within the range |
range(MM/DD-MM/DD) |
|
Never |
Never updates |
never |
|
Non Existing |
Updates if it doesn’t exist |
non_existing |
|
All |
Requires that all comma separated scheduling options inside its brackets be meet in order to run |
all[Options] |
|
daily
is the default whenschedule
is not specified.You can run the script multiple times per day but using the
--time
command line argument detailed on the Run Commands & Environmental Variables Page.You can have multiple scheduling options as a list.
You can use the
delete_not_scheduled
setting to delete Collections that are skipped due to not being scheduled.