Skip to content
/ bokusu Public

Customizable Python app to backup your media (anime, manga, game, tv, movie, book, music) list from multiple sites

License

AGPL-3.0 license
2 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

bokusu/bokusu

BranchesTags

Repository files navigation

Bokusu

Easily backups your media lists from 15 sites and counting with async compability in mind.

Warning

This project is not available to install yet, as it is still in development. You can help by contributing to the project so that it can be released sooner.

Supported Sites

Important

The following sites has been thoroughly tested and supported from previous project, animeManga-autoBackup. The following sites are guaranteed to be implemented and supported in the future.

AniList Anime-Planet Annict Bangumi Kaize
AniList
🍥📔 / 🔐⌛		 Anime-Planet
🍥📔 / 👥📸		 Annict
🍥 / 🔐📸⌛🌐		 Bangumi
🍥📔🎮📺 / 🔐📸🌐		 Kaize
🍥📔 / 👥📸🧼
Kitsu MangaDex MangaUpdates MyAnimeList notify.moe
Kitsu
🍥📔 / 🔐📸		 MangaDex
📔 / 🔐		 MangaUpdates
📔 / 🔐📸		 MyAnimeList
🍥📔 / 👥🔐📸		 Notify
🍥 / 👥📸
Otak Otaku Shikimori Simkl Trakt VNDB
Otak Otaku
🍥 / 👥📸🌐		 Shikimori
🍥📔 / 🔐📸🌐		 SIMKL
🍥📺🎬 / 🔐📸		 Trakt
📺🎬 / 🔐📸⌛		 VNDB
🎮 / 🔐📸

Supported with Caveats

Note

The following sites are supported, but with some caveats. Please read the notes for each site to understand the limitations.

For now, there are no sites that are supported with caveats, yay!

Legends

Supported Media Types
🍥Anime 📔Manga 🎮Games
📺TV Show 🎬Movie 📖Book
🎵Music
Site Information
🔐Requires login 👥List/entry must public 🌐Regionalized sites
📸Wayback Machine support ⌛Exports history log 🧼No Explicit Content
📨Have caveats 🏃Requires bypassing security screening/captcha

Planned for The Integrations

Note

The following sites are planned to be integrated in the future, but not guaranteed to be implemented due some known issues or limitations.

  • aniDB — 🍥 / 🔐📨
    Due to limited UDP API commands, bokusu will only be able to send an export request and read your mail to check if the export is ready. You need to manually download the export file from the mail every 2 weeks.
  • aniSearch — 🍥📔📺🎬 / 👥🌐🏃
  • Doujinshi.info — 📔 / 🔐📸
  • Goodreads — 📖 / 👥⌛📸
  • IMDb — 📺🎬 / 👥📸🏃
  • Kinopoisk — 📺🎬 / 👥🌐📸
  • Kinorium — 📺🎬 / 👥🌐📸
  • Kurozora (former Aozora) — 🍥📔🎮 / 🔐📸
  • Last.fm — 🎵 / 🔐⌛📸
  • ListenBrainz — 🎵 / 🔐⌛📸
  • LiveChart.me — 🍥 / 🔐🏃
  • MyDramaList — 📺🎬 / 👥📸
  • MyShows — 📺🎬 / 👥🌐📸
  • Nautiljon — 🍥📔📺🎬 / 👥🌐📸🏃
  • RAWG — 🎮 / 👥
  • The Movie Database — 📺🎬 / 📸

If you want to see a site that is not listed here, please open an issue and we'll see what we can do.

Export File Interoperability

Bokusu offers multiple export file formats to choose from, so you can choose the one that is most suitable for your use case. In most cases, you only need MAL-flavored XML format so you can import it to other sites that support importing from MAL.

Site XML MALXML JSON RYMSF YAML1 CSV Plain Text Reimportable2
AniList ✅ ✅ ✅ ✅3 MALXML, JSON4
Anime-Planet ✅ ✅ ✅ MALXML
Annict ⭕5 ✅ ⭕5 ✅3
Bangumi ✅ ✅
Kaize ✅6 ✅ ✅ MALXML
Kitsu ✅ ✅ ✅ MALXML
MangaDex ✅ ✅ ✅
MangaUpdates ✅
MyAnimeList ✅ ✅ ✅ MALXML
Notify ✅ ✅ ✅ ✅ ✅ MALXML7
Otak Otaku ✅ ✅ ✅ MALXML
Shikimori ✅ ✅ ✅ MALXML, JSON
SIMKL ✅ ✅ ✅ MALXML7, JSON, CSV
Trakt ✅ ✅3
VNDB ✅ ✅

Requirements and Installations

Before you can use Bokusu, you need to install the following:

  • Python 3.10 or higher, recommended to install 3.11 instead as it is the only version that is fully tested and supported.

We also recommend installing the following for better experience:

  • pipx for installing Bokusu without polluting your system and easily upgrade or uninstall it.

After installing the above, you can install Bokusu by running the following command:

pip install bokusu

Note

  • Replace pip with pipx if you mainly use pipx to install executables.
  • Depending on your system, you may need to use pip3 instead of pip.
  • If pip is reported as not found, add python3 -m (or python -m in some systems) before pip in the command above.

Important

If during installation you may encounter an error related to building the dependencies, you may need to install the following packages first:

Setup and Configuration

To use Bokusu, you need to configure it first. You can do so by running the following command:

bokusu setup

This will ask you to enter your credentials for each site you want to backup, and create a configuration file for you. The configuration file will be stored in your user directory (~/.bokusu), and will be used by bokusu to authenticate you when you run the backup command.

Follow the instructions on the screen to complete the setup, or visit the wiki for more information.

Or, if you want to change your configuration, you can run the following command:

bokusu config --edit

Usage

Bokusu is a command-line tool, so you need to run it in a terminal.

You can also call the program using box as an alias for bokusu if you want to save some keystrokes... but it's not recommended if you have Box (that one cloud storage service) CLI app installed in your system.

Basic Usage

bokusu
# or, if you explicitly set an alias for bokusu
box
# or
python -m bokusu

This will show you the help message and the available commands.

License

Bokusu is licensed under GPL Affero v3.0 or later (AGPL-3.0+) due to heavy dependency of AnimeAPI API for remapping IDs across sites.

We recommend you to use the program as-is and not integrating it to your other open source project/suite, since it will force your project to be licensed under AGPL-3.0+ as well unless the project is copylefted under GPL-3.0+ or compatible GPL licenses.

We are not a lawyer, so please consult your lawyer to make sure you are not violating the license.

Footnotes

  1. Ryuuganime Media Save File format is experimental standardized schema format for media list backup. While it is not supported by any sites yet, it does help Bokusu to be able to convert between different formats. ↩

  2. The site allows you to reimport the exported file back to the site. ↩

  3. Only user records will be exported as plain text for logging. ↩ ↩2 ↩3

  4. AniList does not support reimporting JSON file natively, use Automail userscript to assist. ↩

  5. Due to massive infrastructure differences between Annict with their "record" system and MyAnimeList/RYSMF simple tracking system, some data may be lost during the conversion process. ↩ ↩2

  6. Only Anime will be exported as MALXML due to Kaize and AnimeAPI API limitations. ↩

  7. To import from MALXML, you need to have either MyAnimeList, Kitsu, or AniList account connected to your account. Import XML file to one of those sites, then do a sync to target site. ↩ ↩2

About

Customizable Python app to backup your media (anime, manga, game, tv, movie, book, music) list from multiple sites

Topics

game music automation movies books anime manga myanimelist backup-utility tv-shows backup-tool autobackup

Resources

Readme

License

AGPL-3.0 license
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Contributors 3

  •  
  •  
  •  

Languages