Metadata-Version: 2.5
Name: kodi-rename
Version: 0.1.0
Project-URL: Homepage, https://gitlab.com/thedrunkencoder/kodi-rename
Project-URL: Repository, https://gitlab.com/thedrunkencoder/kodi-rename
Project-URL: Issues, https://gitlab.com/thedrunkencoder/kodi-rename/-/issues
Project-URL: Changelog, https://gitlab.com/thedrunkencoder/kodi-rename/-/blob/main/CHANGELOG.md?ref_type=heads
Project-URL: Documentation, https://gitlab.com/thedrunkencoder/kodi-rename
Author-email: Duncan Fraser <dfraser@thedrunkencoder.uk>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: alive-progress>=3.3.0
Requires-Dist: requests==2.32.3
Description-Content-Type: text/markdown

# Kodi Rename

[![Latest Release](https://gitlab.com/thedrunkencoder/kodi-rename/-/badges/release.svg)](https://gitlab.com/thedrunkencoder/kodi-rename/-/releases)
[![pipeline status](https://gitlab.com/thedrunkencoder/kodi-rename/badges/main/pipeline.svg)](https://gitlab.com/thedrunkencoder/kodi-rename/-/commits/main)
[![coverage report](https://gitlab.com/thedrunkencoder/kodi-rename/badges/main/coverage.svg)](https://gitlab.com/thedrunkencoder/kodi-rename/-/commits/main)
[![GitLab License](https://img.shields.io/gitlab/license/thedrunkencoder%2Fkodi-rename)](https://gitlab.com/thedrunkencoder/kodi-rename/-/blob/main/LICENSE?ref_type=heads)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgitlab.com%2Fthedrunkencoder%2Fkodi-rename%2F-%2Fraw%2Fmain%2Fpyproject.toml%3Fref_type%3Dheads&logo=python)](https://pypi.org/project/kodi-rename/)


Utility for renaming video files from a kodi library.

Over the years of ripping my DVD collection into Kodi, I have not had the best practices with the naming of the files.
Leading to a mess of naming schemes having files that will not parse and have had to manually update the information in Kodi.

Now with looking to update my home media setup and not having enough will power to manually update all of my collection. Here we are


# Installation and usage
## Installation

kodiRename can be installed by running `pip install kodi-rename`, It requires Python 3.11+ to run.

If you want the latest changes and want to install from Gitlab, use `pip install git+https://gitlab.com/thedrunkencoder/kodi-rename`

## Usage

To get started generate a configuration file
```bash
kodiRename init
```
You can also run *kodiRename* as a package if running as a script doesn't work
```bash
python3 -m kodiRename init
```

After updating the generated [configuration file](#usage_and_configuration/index). Collect all the information from Kodi

```bash
kodiRename collect
```

Perform the rename

```bash
kodiRename rename
```

Once all is done, you can delete the left over folders

```bash
kodiRename clean
```

## Configuration

All configuration is provided via a TOML configuration file.

All the commands support providing the configuration file rather than loading the default location
```bash
kodiRename -c other_config.ini init
```

# Future Ideas

Some idea that have been floating around in my head since starting to properly work on this project. That may or may not end up being integrated in.

## Support for other media servers

Getting support for other media server such as [Plex](https://www.plex.tv/) and [JellyFin](https://jellyfin.org/), as this issue is not limited to Kodi.
This will most likely require a rewrite of the collector module to parse the APIs and parse the data into the correct format.

## Integration with metadata providers

Collecting information from metadata providers such as TheTVDb to either expand on the options for naming media.
Or rather than collecting the data from Kodi, attempting to parse from these databases so that the project could be used as the last step in a ripping/transcoding pipeline.

# Contributing

Please feel free to open issues and merge requests if you encounter and issue or just want to help improve this project.
