Skip to content

home

Jump to bottom
elwoodpd edited this page Jul 26, 2020 · 4 revisions

A toolset to assist with the act of finding and downloading music, cleaning and checking it, and then uploading it.

Usage

Every sub-command also has it's own help prompt, which displays information about the sub-command. For example, ./run.py up -h would display the help prompt for the up command.

Usage: run.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  descgen      Generate a description from metadata sources
  downconv     Downconvert a dir of 24bit FLACs to 16bit
  images       Create and manage uploads to image hosts
  meta         Scrape metadata from release link
  metas        Search for releases from metadata providers
  migrate      Migrate database to newest version
  specs        Generate and open spectrals for a folder
  checkspecs   Check the spectrals for a torrent already on site.
  tag          Interactively tag an album
  transcode    Transcode a dir of FLACs into "perfect" MP3
  up           Upload an album folder to RED
  web          Start the salmon web server

Setup

Follow the installation guide. When it comes time to configure the script and set up the config file, please refer to the configuration wiki article.

Updating

smoked salmon uses git for its version control system, which means that changes can easily be pulled from the remote with git pull.

You should run the git pull inside the smoked-salmon directory, for example:

cd ~/.smoked-salmon
git pull

Some updates will require more than just a pull. Notably, the config file is sometimes changed, and the database sometimes needs migrating. Luckily, both occurrences are recorded in the UPGRADING.md file located in the smoked-salmon directory. Please check that file whenever you pull.

Config changes will typically mandate that a new option be added to your config.py file. Look for a new option in the config.py.txt file, and copy that option over to your config.py file.

In the event you have made local changes to salmon and cannot pull, but do not want to keep the changes, you can reset your repository to the state of its last commit with git checkout .. Ran in the root directory of the project (~/.smoked-salmon), this will reset all files to their state prior to your manual edits. You will then be able to pull without an error.

Clone this wiki locally