Almond is a suite of tools that let you archive videos into a database, originally written in Python several years ago with a friend, it now has revamped code and support for many more features.

Almond v2 now uses an API instead of being merged as frontend routes in a web app. This allows developers to create custom clients for it.

Getting started

You can get a binary build in the Releases page, just download it and run it either in your server or locally.

However, if no release build is compatible with your system, you can build one yourself by following the Building guide.

To learn how to use the Almond API, you can read the documentation here (TODO: Generate OpenAPI docs).

Requirements

Important

To run the Almond API, you must have these installed on your system:

yt-dlp - for downloading YouTube videos, does most of the heavy lifting. Install options are listed there too.
yt-dlp-returnyoutubedislike - for adding ReturnYouTubeDislike information to a video's information JSON instead of adding an additional request to the API.
ffmpeg - for video processing in some cases.

Nice to have

An HTTP client like wget, curl, or HTTPie - to request the API without needing an existing front-end, ideal for using the API as a local archiver.
DB Browser for SQLite - to view the contents of your tables inside the Almond database.

Warning

The database currently runs on SQLite, but it may change in the future so the requirements might be different.

Building

Since this project is written in Rust, you will need Rust installed on your system. The site has an installation page that includes instructions for macOS, Linux, Windows, and more.

If you have Git installed on your system and are comfortable using a terminal, you can clone the repository with the following command:

$ git clone https://git.roaming97.com/Almond/api.git

If not, you can download a file by clicking on the "Code" button at the top and extract the source code.

TODO: Finish build guide