anilistarr

README

anilistarr

anilist custom list provider for sonarr/radarr

---

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Converts an Anilist user watching list to a custom list format which *arr apps support.

It works by fetching the user info directly from Anilist thanks to its API, and converts the IDs using community-provided mappings.

Try it out on a live instance at https://anilistarr.fly.dev/. For API details check either the source Swagger definition or the generated online version here.

🏁 Getting Started

Clone the repository and use go run ./cmd/handler/... to get the REST API up.

🔧 Running the tests

Explain how to run the automated tests for this system.

🎈 Usage

Configuration in general is a WIP. The code supports distinct storage and cache options and has built-in support for different caches and stores. The handler needs flags/configuration file support to allow switching at runtime.

Implemented solutions:

• Cache
  • Badger
  • Bolt (no TTL support tho)
  • Redis
• Store
  • Badger
  • SQL (model generated for SQLite, should work for others but YMMV)

🚀 Deployment

The handler binary is statically compiled and serves both the REST API and the telemetry to an OTLP endpoint. Extra requirements depend on which storage and cache technologies you've chosen; e.g. using SQLite/Bolt requires a database file. The Docker image provided contains the handler alone, for instance.

🔧 Built Using

• Golang - Base language
• Chi - net/HTTP-compatible router that doesn't suck
• genqlient - type-safe GraphQL client generator
• xo - SQL client code generator
• Open Telemetry - Observability

🧑‍💻 Authors

• @wwmoraes - Idea & Initial work

🎉 Acknowledgements

• Anilist for their great service and API https://anilist.gitbook.io/anilist-apiv2-docs/
• The community for their efforts to map IDs between services
  • https://github.com/Fribb/anime-lists
  • https://github.com/Anime-Lists/anime-lists/

Documentation

Overview

Package anilistarr provides interfaces and a REST API that converts IDs from anime tracking services such as Anilist to the TVDB IDs wanted by *arr tools.

It relies on community-provided mappings to match the IDs. Tracker information uses the upstream service directly.

Copyright (c) William Artero. MIT License