flemzerd

command module
v0.0.0-...-01b0788 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2021 License: MIT Imports: 33 Imported by: 0

README

Flemzerd Build Status Code Coverage GuardRails badge

Flemzerd is an automation tool (like a very lightweight Sonarr) for handling TV Shows. It watches your tv shows for new episodes, downloads them in the client of your choices, and updates your media center library if needed.

Flemzerd is a daemon intended to track and handle your media library. We are often doing the same thing by hand:

  • Look regularly for new episodes of tv show
  • Once an episode is available, look for a way to download it
  • Launch download in your download client and wait for the download to end
  • Move the episode wherever you store your media and manually update your media center (refresh Kodi library for example)

Flemzerd is intended to automate these tasks.

Documentation

The documentation containing detailed setup instructions, explanations and details about modules is accessible at https://macarrie.github.com/flemzerd/.

Installation

  • Extract the package downloaded from the Releases
  • make install

Update

  • Extract the package downloaded from the Releases
  • make update

Usage

  • Use the binary directly: ./flemzerd -d
  • Use the installed systemd service systemctl start flemzerd
  • Use the docker compose configuration found in the package. This contains all dependencies (Jackett, Transmission and preconfiguration) docker-compose up

See the documentation for more details

Release history

No release yet, flemzerd is still in development

Contribute

Contributions are welcomed:

  • Fork the project
  • Create a branch corresponding to your feature/bugfix
  • Create a Pull Request containing an explanation of the changes and their motives

More informations about development setup can be found on the corresponding documentation page: Development setup

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package db provides access to local database and gives some shortcuts for getting certain types of objects The ultimate goal is to create an abstraction layer for data access so an underlying database structure change does not require to change the entire codebase
Package db provides access to local database and gives some shortcuts for getting certain types of objects The ultimate goal is to create an abstraction layer for data access so an underlying database structure change does not require to change the entire codebase
Package notifier groups methods for notifications handling in flemzerd.
Package notifier groups methods for notifications handling in flemzerd.
Package watchlist groups methods for retrieving items (shows and movies) form multiple watchlists Multiple watchlist types can be registered.
Package watchlist groups methods for retrieving items (shows and movies) form multiple watchlists Multiple watchlist types can be registered.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL