Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xbgmsharp/trakt

Import CSV to Trakt.tv list and Export Trakt.tv list into CSV
https://github.com/xbgmsharp/trakt

Last synced: 3 months ago
JSON representation

Import CSV to Trakt.tv list and Export Trakt.tv list into CSV

Host: GitHub
URL: https://github.com/xbgmsharp/trakt
Owner: xbgmsharp
License: gpl-3.0
Created: 2016-04-26T15:13:40.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-06-10T09:03:43.000Z (5 months ago)
Last Synced: 2024-06-18T04:36:00.071Z (5 months ago)
Language: Python
Homepage:
Size: 96.7 KB
Stars: 271
Watchers: 15
Forks: 47
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Trakt.tv tools

- [Trakt.tv tools](#trakttv-tools)
* [Purpose](#purpose)
* [Requirements](#requirements)
+ [On Docker](#on-docker)
+ [On Ubuntu/Debian Linux system](#on-ubuntu-debian-linux-system)
+ [On Arch/Manjaro Linux system](#on-arch-manjaro-linux-system)
+ [On Windows system](#on-windows-system)
+ [On macOS system](#on-macos-system)
* [Usage](#usage)
* [Configuration](#configuration)
+ [Configuration sample](#configuration-sample)
+ [Configuration details](#configuration-details)
* [Developer documentation](#developer-documentation)
* [Howto](#howto)
+ [Import](#import)
+ [Export](#export)
+ [Sync](#sync)
+ [Export data from Kodi](#export-data-from-kodi)
+ [Export data from CouchPotato](#export-data-from-couchpotato)
* [Support](#support)
* [Contribution](#contribution)
* [Licence](#licence)

## Purpose

* Import Movies or TVShows IDs from CSV file format into Trakt.tv.
* Import Ratings of Movies or TVShows IDs from CSV file format into Trakt.tv.
* Export Movies or TVShows IDs from Trakt.tv list into CSV file format.
* Create trakt.tv custom list from TDMB discover with filter.

## Requirements

You must use Python 3.x.

### On Docker

To run [Docker hub image](https://hub.docker.com/r/xbgmsharp/docker-trakt-tools)
```bash
$ docker pull xbgmsharp/docker-trakt-tools
$ docker run -it --rm --name my-trakt-tools xbgmsharp/docker-trakt-tools python export_trakt.py -v
export_trakt.py 0.3
```

You might need to use the `--privileged` options on some case/
```bash
$ docker run --privileged -it --rm --name my-trakt-tools xbgmsharp/docker-trakt-tools python export_trakt.py -v
export_trakt.py 0.3
```

Create and edit default config
```bash
$ docker run -it --rm \
--name my-trakt-tools \
-v $(pwd):/trakt/export \
-v $(pwd):/trakt/config \
xbgmsharp/docker-trakt-tools \
python export_trakt.py -c config/config.ini
```

Run export
```bash
$ docker run -it --rm \
--name my-trakt-tools \
-v $(pwd):/trakt/export \
-v $(pwd):/trakt/config \
xbgmsharp/docker-trakt-tools \
python export_trakt.py -c config/config.ini -o export/export_movies_history.csv
```

`my-trakt-tools` is the container name.

`xbgmsharp/docker-trakt-tools` is the image name.

To build the image
```bash
$ docker build -t xbgmsharp/docker-trakt-tools .
```

To build the multi-arch image
```bash
$ ./multi-arch-docker-ci.sh
```

### On Ubuntu/Debian Linux system

Ensure you are running Python 3
```
$ python -V
Python 3.5
```

Install need module dependencies, `python3-openssl` and `jq` are optional

```
$ apt-get install python3-dateutil python3-simplejson python3-requests python3-openssl jq
```

### On Arch/Manjaro Linux system

Install dependencies with pacman, `python-pyopenssl` and `jq` are optional

```
$ pacman -S python python-dateutil python-simplejson python-requests python-pyopenssl jq
```

### On Windows system

Download the installer: https://www.python.org/downloads/windows/

Ensure you are running Python 3
```
>python.exe -V
Python 3.5
```

Install need module dependencies

```
\Scripts\pip3.exe install requests simplejson
```

### On macOS system

Download the installer: https://www.python.org/downloads/mac-osx/

Append to PATH in ZSH

```shell
$ path=('/Library/Frameworks/Python.framework/Versions/3.8/bin' $path)
```

Ensure you are running Python 3

```shell
$ python3 -V
Python 3.8.5
```

Run Install Certificates.command

```shell
$ pip3 install certifi
```

Open a new Terminal session so that certificates will be available

Install need module dependencies, `pyopenssl` and `jq` are optional

```shell
$ pip3 install python-dateutil
$ pip3 install simplejson
$ pip3 install requests
$ pip3 install pyopenssl
$ pip3 install jq
```

## Usage

* Create an [Trakt.tv application](https://trakt.tv/oauth/applications) to have your own ``client_id`` and ``client_secret``, https://trakt.tv/oauth/applications.
You only need to fill up the ``Name`` with a ``Description`` and ``Redirect uri`` to `urn:ietf:wg:oauth:2.0:oob`, leave the rest empty and click on ``SAVE APP``.

* Run the script to create a default config file ``config.ini``

```
$ python export_trakt.py
```

* Edit the config file ``config.ini`` and specify the ``client_id`` and ``client_secret`` as well as any other settings appropriate to your enviromenent, eg: URL, proxy, etc...
Refer to [Configuration details](#configuration) section for more information.

```
$ vim config.ini
```

* Run the script to authenticate against Trakt.tv API using the PIN method and it will generate an ``access_token`` and ``refresh_token``. You will be prompted to open a link into a browser and paste the pincode back to the script. The generated ``access_token`` and ``refresh_token`` are automaticaly saved into the config file ``config.ini``.

```
$ python export_trakt.py
```

## Configuration

### Configuration sample

```text
[TRAKT]
client_id = xxxxxxxxxxxxxxxxxxxxxxxxx
client_secret = xxxxxxxxxxxxxxxxxxxxxx
access_token =
refresh_token =
baseurl = https://api-v2launch.trakt.tv
[SETTINGS]
proxy = False
proxy_host = https://127.0.0.1
proxy_port = 3128
```

### Configuration details

* ``client_id``: Uniq ID to identify your application, https://trakt.tv/oauth/applications
* ``client_secret``: Uniq ID to identify your application, https://trakt.tv/oauth/applications
* ``access_token``: Uniq ID to identify yourself against your application, manage by the script
* ``refresh_token``: Uniq ID to identify yourself against your application, manage by the script
* ``baseurl``: API base URL, depends on the platfrom, eg: Production (https://api-v2launch.trakt.tv) or Staging (https://api-staging.trakt.tv)
* ``proxy``: True/False setting to enable proxy support
* ``proxy_host``: Full URI of the proxy
* ``proxy_port``: Port of the proxy to connect to

## Developer documentation

```bash
$ pydoc `pwd`/import_trakt.py
$ pydoc `pwd`/export_trakt.py
$ pydoc `pwd`/sync_tmdb_trakt.py
```

## Howto

### Import

[Import CSV into trakt.tv](import.md)

### Export

[Export data from trakt.tv into CSV](export.md)

### Sync

[Create trakt.tv list from TDMB discover with filter](sync.md)

### Export data from Kodi

Export Movies or TVShows IDs from Kodi into CSV file format.
[Export data from Kodi](KODI.md)

### Export data from CouchPotato

Export Movies IDs from CouchPotato into CSV file format.
[Export data from CouchPotato](CouchPotato.md)

## Support

To get support, please create new [issue](https://github.com/xbgmsharp/trakt/issues)

## Contribution
I'm happy to accept Pull Requests!

## License

This script is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See .