[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/shaneisrael/plex-auto-genres/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","shaneisrael","reponame","plex-auto-genres","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2021-01-06T21:07:31.871836Z","description","Automatically add genre collection tags to your Plex Media Server.","is_private","last_updated","2022-12-25T04:12:36.929516Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",145205,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# Plex Auto Genres\n\nPlex Auto Genres is a simple script that will add genre collection tags to your media making it much easier to search for genre specific content\n\n1. [Requirements](#requirements)\n2. [Optimal Setup](#optimal)\n3. [Getting Started](#getting_started)\n4. [Automating](#automating)\n5. [Troubleshooting](#troubleshooting)\n6. [Docker Usage](#docker_usage)\n\n###### Movies example (with cover art set using --set-posters flag.)\n![Movie Collections](/images/movies.png)\n\n###### Anime example\n![Anime Collections](/images/animes.png)\n\n## Requirements\n1. Python 3 - Instructions > [Windows / Mac / Linux](https://installpython3.com/)\n2. [TMDB Api Key](https://developers.themoviedb.org/3/getting-started/introduction) (Only required for non-anime libraries)\n\n\n## Optimal Setup\n\n1. Anime / Anime Movies are in their own library on your plex server. **_(Anime and Anime Movies can share the same library)_**\n2. Standard TV Shows are in their own library on your plex server.\n3. Standard Movies are in their own library on your plex server.\n4. Proper titles for your media, this makes it easier to find the media. (see https://support.plex.tv/articles/naming-and-organizing-your-tv-show-files/)\n\nFor this to work well your plex library should be sorted. Meaning standard and non-standard media should not be in the same Plex library. Anime is an example of non-standard media.\n\nIf your anime shows and standard tv shows are in the same library, you can still use this script just choose (**standard**) as the type. However, doing this could cause incorrect genres added to some or all of your anime media entries.\n\n###### Here is an example of my plex library setup\n![Plex Library Example](/images/example-library-setup.png)\n\n## Getting Started \n1. Read the **Optimal Setup** section above\n2. Install the python dependencies listed in `requirements.txt`, if you have pip you can simply do `pip install -r requirements.txt`\n3. Rename the `.env.example` file to `.env`\n4. Edit the `.env` file and set your plex username, password, and server name. If you are generating collections for standard media (non anime) you will need to also obtain an [TMDB Api Key](https://developers.themoviedb.org/3/getting-started/introduction) (for movies and tv shows) \n |Variable|Authentication method|Value|\n |---|---|---|\n |PLEX_USERNAME|Username and password|Your Plex Username|\n |PLEX_PASSWORD|Username and password|Your Plex Password|\n |PLEX_SERVER_NAME|Username and password|Your Plex Server Name|\n |PLEX_BASE_URL|Token|Your Plex Server base URL|\n |PLEX_TOKEN|Token|Your Plex Token|\n |PLEX_COLLECTION_PREFIX||(Optional) Prefix for the created Plex collections. For example, with a value of \"\\*\", a collection named \"Adventure\", the name would instead be \"*Adventure\".

Default value : \"\"|\n |TMDB_API_KEY||Your TMDB api key (not required for anime library tagging)|\n5. Optional, If you want to update the poster art of your collections. See `sample_posters/readme.txt`\n\nYou are now ready to run the script\n```\nusage: plex-auto-genres.py [-h] [--library LIBRARY] [--type {anime,standard}]\n\nAdds genre tags (collections) to your Plex media.\n\noptional arguments:\n -h, --help show this help message and exit\n --library LIBRARY The exact name of the Plex library to generate genre collections for.\n --type {anime,standard-movie,standard-tv}\n The type of media contained in the library\n --set-posters uploads posters located in posters/ of matching collections. Supports (.PNG)\n --dry Do not modify plex collections (debugging feature)\n --no-progress Do not display the live updating progress bar\n -f, --force Force proccess on all media (independently of proggress recorded in logs/).\n -y, --yes Do not prompt.\n\nexample: \npython plex-auto-genres.py --library \"Anime Movies\" --type anime\npython plex-auto-genres.py --library \"Anime Shows\" --type anime\npython plex-auto-genres.py --library Movies --type standard-movie\npython plex-auto-genres.py --library \"TV Shows\" --type standard-tv\npython plex-auto-genres.py --library Movies --type standard-movie --set-posters\n```\n\n![Example Usage](/images/example-usage.gif)\n\n## Automating\nI have conveniently included a script to help with automating the process of running plex-auto-genres when combined with any number of cron scheduling tools such as `contab`, `task scheduler`, etc. \n\n**If you have experience with Docker I reccommend using my docker image which will run on a schedule.**\n\n1. Copy `.env.example` to `.env` and update the values\n2. Copy `config.json.example` to `config.json` and update the values\n4. Each entry in the `run` list will be executed when you run this script\n5. Have some cron/scheduling process execute `python3 automate.py`, I suggest running it manually first to test that its working.\n\n**Note:** *The first run of this script may take a long time (minutes to hours) depending on your library sizes.*\n\n**Note:** *Don't be alarmed if you do not see any text output. The terminal output you normally see when running `main.py` is redirected to the log file **after** each executed `run` in your `config`.*\n\n## Docker Usage\n\n1. **[Install Docker](https://docs.docker.com/get-docker/)**\n2. **[Install Docker Compose](https://docs.docker.com/compose/install/)**\n3. Clone or Download this repository\n4. Edit `docker/docker-compose.yml` \n 1. Update the `volumes:` paths to point to the `config`,`logs`,`posters` directories in this repo.\n 2. Update the `environment:` variables. See [Getting Started](#getting_started).\n5. Copy `config/config.json.example` to `config/config.json`\n 1. Edit the `run` array examples to match your needs. When the script runs, each library entry in this array will be updated on your Plex server. \n6. Run `docker-compose up -d`, **the script will run immediately then proceed to run on a schedule every night at 1am UTC.** Logs will be located at `logs/plex-auto-genres-automate.log`\n\n Another Docker option of this tool can be **[found here.](https://github.com/fdarveau/plex-auto-genres-docker)**\n\n\n## Troubleshooting\n1. If you are not seeing any new collections close your plex client and re-open it.\n2. Delete the generated `plex-*-successful.txt` and `plex-*-failures.txt` files if you want the script to generate collections from the beginning. You may want to do this if you delete your collections and need them re-created.\n3. Having the release year in the title of a tv show or movie can cause the lookup to fail in some instances. For example `Battlestar Galactica (2003)` will fail, but `Battlestar Galactica` will not.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",4107256367,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":61,"_124":17},"content_type","creator",1270878,"digest","sha256:9bba70a9c92339f56b8e10f2a28d6a49a45671f257ca13442025e9302c15a1a4","full_size",141300731,"id",132269503,"images",[99],{"_100":101,"_91":92,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":94,"_59":61,"_113":-5},"architecture","amd64","features","","last_pulled","2026-09-22T02:42:40.915868048Z","last_pushed","2022-12-25T04:12:37Z","os","linux","os_features","os_version","size","variant","2022-12-25T04:12:36.796283Z","last_updater","last_updater_username","media_type","latest","repository",10630227,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":58,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":61,"_124":17},[152],{"_100":101,"_91":92,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":94,"_59":61,"_113":-5},[],"canDeleteTags","actionData","errors"]

shaneisrael/plex-auto-genres

Tags for shaneisrael/plex-auto-genres