Metadata-Version: 2.4
Name: plexutil
Version: 3.0.9
Author-email: Carlos Florez <carlos@florez.co.uk>
Maintainer-email: Carlos Florez <carlos@florez.co.uk>
License: MIT License
        
        Copyright (c) 2024 CARLOS FLOREZ
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/florez-carlos/plexutil
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PlexAPI==4.17.2
Requires-Dist: alive-progress==3.3.0
Requires-Dist: pyyaml==6.0.3
Requires-Dist: toml==0.10.2
Requires-Dist: pywin32==311; sys_platform == "win32"
Requires-Dist: jsonschema==4.25.1
Requires-Dist: peewee==3.18.3
Requires-Dist: colorlog==6.10.1
Requires-Dist: pyjwt[crypto]==2.10.1
Dynamic: license-file

# Plexutil

CLI for Plex Media Server.

![PyPI Version](https://img.shields.io/pypi/v/plexutil)
![Python](https://img.shields.io/badge/Python-3.11+-blue)
![Platform](https://img.shields.io/badge/Platform-Cross--Platform-success)
![PyPI Status](https://img.shields.io/pypi/status/plexutil)
![CLI](https://img.shields.io/badge/Interface-CLI-important)


> [!NOTE]
> Installation is supported only for the following: 
> - Windows (amd64)
> - Linux (amd64)
>    - X11
>    - Wayland


## Table of Contents

* [Installation](#installation)
* [Usage](#usage)
  * [Creating a media library](#creating-a-media-library-or-music-playlist)
  * [Deleting a media library](#deleting-a-media-library-or-music-playlist)
  * [Exporting/Importing Music Playlists](#exportingimporting-music-playlists)
* [Development](#development)
* [Log Location](#log-location)


## Installation
> [!NOTE]
> - Requires Python 3.11+<br >
> - Requires pip
```bash
pip install plexutil
```
---

## Usage
### Creating a media library or music playlist:
> [!NOTE]
> If language is not supplied, the default is en-US
```bash
plexutil create
```

### Deleting a media library or music playlist:
```bash
plexutil delete
```

### Exporting/Importing Music Playlists
Music Playlists can be exported to a playlists.db file, this file can later be imported to another Plex server with plexutil
```bash
plexutil download
```
This action will create a playlists.db file in your current directory <br >
This file can then be used to recreate the playlists in another Plex Server with plexutil by doing
```bash
plexutil upload
```
> [!NOTE]
> The songs in the Music Library of the importing server must match the songs in the exporting server

## Development
> [!NOTE]
> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
```bash
source init.sh
```

## Log Location
The log directory of Plexutil is located:
> [!NOTE]
> Replace <YOUR_USER> with your Windows UserName
- Windows
```bash
C:\Users\<YOUR_USER>\Documents\plexutil\log
```
- Linux
```bash
$HOME/plexutil/log
```
> [!NOTE]
> Log files are archived based on date, such as yyyy-mm-dd.log

## License
[MIT](https://choosealicense.com/licenses/mit/)

