Skip to main content

Sync your ani-cli progress with a remote server.

Project description

ani-sync README

Welcome to ani-sync, the syncing tool I made to keep my anime watch progress consistent across devices. Honestly, this was a personal project that got slightly out of hand. Expect some rough edges—it’s not perfect, and I won’t pretend it is. 99% was ChatGPT's work. If it works for you, great! If not, well… it works on my machine


Features

  • Sync Your Progress: Keep track of what you’ve watched with ani-cli across your PC, phone or other devices (samsung smart fridge maybe?).
  • Cloud Storage: Syncs progress to a remote server by default (ani-sync.hamzie.site:25507).
  • Arguments Compatibility: Run ani-sync with the same arguments as ani-cli and more.
  • Open Source: Both the client and server are open-source because trust matters.

How It Works

ani-sync acts as a wrapper around ani-cli, handling syncing automatically before and after your anime sessions. By default, it uses ani-sync.hamzie.site to store and authenticate your data. The server saves your progress as plain text files—yes, I could technically read them, but I don’t care about your anime habits. You’ll just have to trust me the same way you trust big corporations. But I’ve got better things to do then look what episode you are at on Naruto.

If you’re privacy-focused (for anime? really?), you can host your own server. Check out the server code here: Hamziee/ani-sync-server. (don't expect anything good)


Setup & Installation

Clone and install:

git clone https://github.com/Hamziee/ani-sync.git
cd ani-sync
pip install .

Requirements:

  • ani-cli installed and in your PATH
  • Python 3.x
  • Git Bash (Windows users) (you should have this already if u installed ani-cli correctly, if not, then, okay, how are you using it???)

Usage

Basic Sync Flow:

  1. If you’ve been using ani-cli already, first upload your progress:
    ani-sync --- --upload
    
  2. After that, just run:
    ani-sync
    
    It’ll handle syncing automatically.

Commands:

  • Register an account:
    ani-sync --- --register
    
  • Log in:
    ani-sync --- --login
    
  • Upload progress: [!] This is done automatically after you finished watching and clicked quit in ani-cli
    ani-sync --- --upload
    
  • Download progress: [!] This is done automatically when you start it
    ani-sync --- --download
    

Passing Arguments:

  • Pass ani-cli arguments directly:
    ani-sync -c --dub
    
  • Pass ani-sync arguments with ---:
    ani-sync --- --upload
    

FAQ

Q: Is this stable?

A: Define stable

Q: Can I trust this?

A: You trust big corporations with your data, don’t you? This is no different—just smaller scale and open source and anime which is not really personal data.

Q: What if I don’t trust anyone?

A: Sure, grab the server code here: Hamziee/ani-sync-server and host it yourself, you got something to hide huh?

Credits

  • Me (Hamza) for duct-taping this together.
  • ChatGPT working hard for 4 hours and getting working code after being yelled at (i said thank you at the very end)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ani_sync-0.1.1.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ani_sync-0.1.1-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file ani_sync-0.1.1.tar.gz.

File metadata

  • Download URL: ani_sync-0.1.1.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.5

File hashes

Hashes for ani_sync-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3ad1507013589d16ad42c25b9a97a19bd47b8e989f880d6cdc447eb1d4f2cdd0
MD5 69c2f6afa2f90e6738934c9521a9c706
BLAKE2b-256 3c11cc41333b30c4cb1689ee5dc1e9b5b49a51c658c8b448ccb13f772855d5ef

See more details on using hashes here.

File details

Details for the file ani_sync-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ani_sync-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.5

File hashes

Hashes for ani_sync-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7b8e57acfb142d9a7a0c1a0472d710e702ddafff0e2afa5e1444bca98e731c
MD5 ddbec56c183b89411f16adc104a0f258
BLAKE2b-256 33fe2420e98078b3747ceadd69d74ba9b1e6e0570ca2c94618b9a1f6ec117959

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page