Skip to content

Obsidian Custom Discogs Vault, version 1.0.2r6

Latest
Latest
Compare
Choose a tag to compare
@doctorfree doctorfree released this 08 Apr 18:22
· 1 commit to main since this release
v1.0.2r6
5047b71

Release Notes

Table of contents

  1. Overview
  2. Quickstart
  3. Installation
  4. Configuration
  5. Customization
  6. Removal
  7. Support
  8. Changelog

Overview

The Obsidian Custom Discogs vault is an Obsidian vault designed to automate the generation of Discogs items and artist descriptions in markdown format. It can be viewed using any markdown viewer (e.g. almost any browser) but if Obsidian is used then many additional features will be available including queries using the Dataview plugin for Obsidian.

The Obsidian-Custom-Discogs repository can be used to automate the generation of Obsidian vault markdown files that reflect the items and artists in a Discogs collection. See the description of Process for an overview of the process and tools employed in the creation of this repository.

New in this release:

  • Support for adding releases to a Discogs collection
    • From previous Setup -L /path/to/library generated markdown
    • Can specify collection folder name
    • Can specify local input folder name
    • Can use existing collection folder or create new folder
    • Checks if release already exists in collection

An example Obsidian vault, my Obsidian Discogs Vault, created using these tools can be downloaded and viewed at https://github.com/doctorfree/Obsidian-Discogs-Vault/releases/latest (it's quite large).

These are the release notes for Version 1.0.2 Release 4 of the Obsidian Custom Discogs project.

Quickstart

  1. Download the vault
  2. Extract the vault: tar xf /path/to/Obsidian-Custom-Discogs-1.0.2r6.tar.gz
  3. Set the Discogs username (DISCOGS_USER) and API token (DISCOGS_TOKEN) in $HOME/.config/mpprc
  4. Customize the vault by running ./Setup in the vault folder
  5. Open the vault in Obsidian via "Open another vault -> Open folder as vault"

Installation

The Obsidian Custom Discogs vault can be installed on Windows, Mac, or Linux. The following installation instructions are for Mac and Linux. Windows users can follow similar steps.

For the optimal experience, open this vault in Obsidian!

  1. Download the vault
  2. Open the vault in Obsidian via "Open another vault -> Open folder as vault"
  3. Trust us. :)
  4. When Obsidian opens the settings, verify that the "Dataview", "Excalidraw", and "Excalibrain" plugins are enabled
  5. Done! The Obsidian Custom Discogs vault is now available to you in its purest and most useful form!

Download the release archive

Download the latest release.

Those familiar with wget can download this release from the command line with:

wget --quiet -O ~/Downloads/Obsidian-Custom-Discogs-v1.0.2r6.tar.gz \
  https://github.com/doctorfree/Obsidian-Custom-Discogs/archive/refs/tags/v1.0.2r6.tar.gz

Extract the release archive

Currently release archives are available in either ZIP or compressed tar archive format.

To extract the ZIP archive:

cd /path/to/your/vaults # e.g. `cd ~/Documents/Obsidian`
unzip /path/to/Obsidian-Custom-Discogs-1.0.2r6.zip

To extract the compressed tar archive:

cd /path/to/your/vaults # e.g. `cd ~/Documents`
tar xf /path/to/Obsidian-Custom-Discogs-1.0.2r6.tar.gz

Once extracted, the Obsidian Custom Discogs vault is now available in /path/to/your/vaults/Obsidian-Custom-Discogs-1.0.2r6/.

The downloaded archive can be deleted:

rm -f /path/to/Obsidian-Custom-Discogs-1.0.2r6.zip

or

rm -f /path/to/Obsidian-Custom-Discogs-1.0.2r6.tar.gz

Clone the repository

Alternatively, this repository can be cloned with the command:

git clone https://github.com/doctorfree/Obsidian-Custom-Discogs.git

Cloning will get all of the latest changes including those made since the latest release.

Configuration

The Obsidian Custom Discogs vault is pre-configured for use with Obsidian. Install Obsidian for your platform by clicking the appropriate installation link at the Obsidian website. Obsidian is available for Windows, Mac, and Linux as well as mobile devices.

Add a new vault in Obsidian with Open folder as vault and navigate to the Obsidian-Custom-Discogs-1.0.2r6 extracted folder. When prompted, Trust and enable the Dataview plugin if it is not already enabled.

The Obsidian Custom Discogs vault includes the Doctorfree Obsidian theme. Enable this Obsidian theme in Obsidian by visiting Settings -> Appearance and selecting Doctorfree from the dropdown in the Themes section.

Obsidian is required for some features but is not necessary to view the Obsidian Custom Discogs vault. Any markdown viewer/editor can be used. If the Obsidian Custom Discogs vault is extracted into a website folder, it can be viewed using most browsers.

Dataview Queries

The Obsidian Custom Discogs vault has been curated with metadata allowing queries to be performed using the Obsidian Dataview plugin. Sample queries along with the code used to perform them can be viewed in the Dataview Queries document and the generated Dataview markdown in the Dataviews folder of an initialized vault.

Customization

Scripts included with the Obsidian Custom Discogs vault make it possible to customize the vault with your personal Discogs collection. If you have a Discogs account and have curated a Discogs collection there, then you can run the Obsidian Custom Discogs vault scripts to generate vault markdown reflecting your Discogs collection. These instructions will setup an automated workflow to retrieve your Discogs collection via the Discogs API and generate markdown from that collection.

The Discogs API requires a Discogs username and, optionally, a Discogs API token. These can be found in your Discogs account and placed in the file $HOME/.config/mpprc as follows:

# The Discogs username can be found by visiting discogs.com. Login, use the
# dropdown of your user icon in the upper right corner, click on 'Profile'.
# Your Discogs username is the last component of the profile URL. IF you do
# not have a Discogs account, leave blank.
DISCOGS_USER="your_discogs_username"
# The Discogs API token can be found by visiting
# https://www.discogs.com/settings/developers
DISCOGS_TOKEN="your_discogs_api_token"

After configuring your Discogs username and API token, generate markdown for your Discogs collection by running the Setup script:

./Setup

The resulting markdown and cover art can be found in the Username and assets folders where Username is your capitalized Discogs username.

If you wish to generate markdown from another Discogs user, run the Setup script with the -u user option. For example, to generate markdown for the items and artists in Discogs user Dr_Robert's collection, run the following:

./Setup -u Dr_Robert

The resulting markdown and cover art can be found in the Dr_Robert and assets folders.

[Note:] For large Discogs collections this process can take a while.

Removal

To remove the Obsidian Custom Discogs vault simply remove the extracted folder and its contents:

cd /path/to/your/vaults # e.g. `cd ~/Documents/Obsidian`
rm -rf Obsidian-Custom-Discogs-1.0.2r6

Support

Support the development and improvement of the Obsidian Custom Discogs vault by sponsoring the Projects of Doctorfree.

Changelog

View the full changelog for this release at https://github.com/doctorfree/Obsidian-Custom-Discogs/blob/v1.0.2r6/CHANGELOG.md

Assets 2
Loading