Skip to content

Commit

Permalink
Death to monolithic READMEs, directories are fun.
Browse files Browse the repository at this point in the history
  • Loading branch information
VxJasonxV committed Jul 3, 2014
1 parent 70ff96a commit 0d84bdb
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 72 deletions.
74 changes: 2 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,3 @@
# Directory File Parsers #
# MusicBrainz Track Parsers #

## Requirements ##

* [Audio::Scan](http://search.cpan.org/~agrundma/Audio-Scan-0.87/lib/Audio/Scan.pm)
* Perl. I'm not going to explain how to get it.

## Usage ##

Invoke a file format script suitable for the media in your files, pipe to sort if necessary.

## Roadmap / Wishlist ##

* Suitable framework for detecting file-formats, both dumbly (by extension) and smartly (by file magic/mimetype), turning this into just a single script.
* Seamless `pbcopy` integration into OS X environments.
* Smart artist display, automatically when "Various Artists" is seen, or when differing artists are detected on tracks.

--------

# Bandcamp Parser #

## Requirements ##

* Perl >= 5.10. I'm not going to explain how to get it nor upgrade to it.
* [URI](https://metacpan.org/pod/URI)
* [LWP::Simple](https://metacpan.org/pod/LWP::Simple)
* [JSON](https://metacpan.org/pod/JSON) >= 2.0 (JSON::XS generally recommended, additionally.)
* [DateTime](https://metacpan.org/pod/DateTime)
* [DateTime::Format::Duration](https://metacpan.org/pod/DateTime::Format::Duration)

* Requires an API Key from Bandcamp. See [http://bandcamp.com/developer#key_request](http://bandcamp.com/developer#key_request)
* Add the API Key into your environment as the value of the $BCAPIKEY variable. I'm not going to explain how to do this.

## Usage ##

Visit a Bandcamp URL, a specific album or even track as part of an album. Copy the URL and paste it into a terminal as an argument to the Bandcamp script.

Ex. `perl bandcamp.pl "http://rainbowdragoneyes.bandcamp.com/track/seize-my-day"`

Artists with only one Album/Track will have that information automatically printed. Otherwise a track will be resolved back to it's release, or printed as-is. An album will be printed as-is. And artist URL with multiple albums will list albums and URLs suitable for immediately copying back into execution.

## Roadmap / Wishlist ##

* Refactor
* Refactor
* Refactor

--------

# Beatport Parser #

## Requirements ##

* Perl >= 5.10
* [LWP::Simple](https://metacpan.org/pod/LWP::Simple)
* [JSON](https://metacpan.org/pod/JSON) >= 2.0 (JSON::XS generally recommended, additionally.)
* [Carp](https://metacpan.org/pod/Carp)
* [HTML::Query](https://metacpan.org/pod/HTML::Query)
* [File::Temp](https://metacpan.org/pod/File::Temp)

## Usage ##

Visit a beatport.com release page, it MUST begin with beatport.com/release. Copy the URL and paste it into a terminal as an argument to the Beatport script.

Ex. `perl beatport.pl "http://www.beatport.com/release/different-morals/393408"`

## Caveats ##

Artist information may be quite a bit wacky, mostly because Beatport's artist classification is insanity. Please take care to check that all artist credits are correct. If you know more than me about how Beatport represents their artists, [let me know!](https://github.com/VxJasonxV/MusicBrainz-Track-Parsers/issues)

## Roadmap / Wishlist ##

* General cleanup and some error handling maybe?
This repository is a collection of perl scripts that can automatically pull in release information from various sources, format it and prepare it as much as possible for inserting into MusicBrainz. Each folder has it's own README file to document how the enclosed script(s) work. Give the relevant directory a click.
27 changes: 27 additions & 0 deletions bandcamp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Bandcamp Parser #

## Requirements ##

* Perl >= 5.10. I'm not going to explain how to get it nor upgrade to it.
* [URI](https://metacpan.org/pod/URI)
* [LWP::Simple](https://metacpan.org/pod/LWP::Simple)
* [JSON](https://metacpan.org/pod/JSON) >= 2.0 (JSON::XS generally recommended, additionally.)
* [DateTime](https://metacpan.org/pod/DateTime)
* [DateTime::Format::Duration](https://metacpan.org/pod/DateTime::Format::Duration)

* Requires an API Key from Bandcamp. See [http://bandcamp.com/developer#key_request](http://bandcamp.com/developer#key_request)
* Add the API Key into your environment as the value of the $BCAPIKEY variable. I'm not going to explain how to do this.

## Usage ##

Visit a Bandcamp URL, a specific album or even track as part of an album. Copy the URL and paste it into a terminal as an argument to the Bandcamp script.

Ex. `perl bandcamp.pl "http://rainbowdragoneyes.bandcamp.com/track/seize-my-day"`

Artists with only one Album/Track will have that information automatically printed. Otherwise a track will be resolved back to it's release, or printed as-is. An album will be printed as-is. And artist URL with multiple albums will list albums and URLs suitable for immediately copying back into execution.

## Roadmap / Wishlist ##

* Refactor
* Refactor
* Refactor
File renamed without changes.
24 changes: 24 additions & 0 deletions beatport/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Beatport Parser #

## Requirements ##

* Perl >= 5.10
* [LWP::Simple](https://metacpan.org/pod/LWP::Simple)
* [JSON](https://metacpan.org/pod/JSON) >= 2.0 (JSON::XS generally recommended, additionally.)
* [Carp](https://metacpan.org/pod/Carp)
* [HTML::Query](https://metacpan.org/pod/HTML::Query)
* [File::Temp](https://metacpan.org/pod/File::Temp)

## Usage ##

Visit a beatport.com release page, it MUST begin with beatport.com/release. Copy the URL and paste it into a terminal as an argument to the Beatport script.

Ex. `perl beatport.pl "http://www.beatport.com/release/different-morals/393408"`

## Caveats ##

Artist information may be quite a bit wacky, mostly because Beatport's artist classification is insanity. Please take care to check that all artist credits are correct. If you know more than me about how Beatport represents their artists, [let me know!](https://github.com/VxJasonxV/MusicBrainz-Track-Parsers/issues)

## Roadmap / Wishlist ##

* General cleanup and some error handling maybe?
File renamed without changes.
16 changes: 16 additions & 0 deletions file-tags/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Directory File Parsers #

## Requirements ##

* [Audio::Scan](http://search.cpan.org/~agrundma/Audio-Scan-0.87/lib/Audio/Scan.pm)
* Perl. I'm not going to explain how to get it.

## Usage ##

Invoke a file format script suitable for the media in your files, pipe to sort if necessary.

## Roadmap / Wishlist ##

* Suitable framework for detecting file-formats, both dumbly (by extension) and smartly (by file magic/mimetype), turning this into just a single script.
* Seamless `pbcopy` integration into OS X environments.
* Smart artist display, automatically when "Various Artists" is seen, or when differing artists are detected on tracks.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 0d84bdb

Please sign in to comment.