diff --git a/docs/album.docs b/docs/album.docs new file mode 100644 --- /dev/null +++ b/docs/album.docs @@ -0,0 +1,37 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __addTags__ \ +-- | Tag an album using a list of user supplied tags. \ +More: + +#define __getBuyLinks__ \ +-- | Get a list of Buy Links for a particular Album. It is required that you supply either the artist and track params or the mbid param. \ +More: + +#define __getInfo__ \ +-- | Get the metadata for an album on Last.fm using the album name or a musicbrainz id. See playlist.fetch on how to get the album playlist. \ +More: + +#define __getShouts__ \ +-- | Get shouts for this album. \ +More: + +#define __getTags__ \ +-- | Get the tags applied by an individual user to an album on Last.fm. \ +More: + +#define __getTopTags__ \ +-- | Get the top tags for an album on Last.fm, ordered by popularity. \ +More: + +#define __removeTag__ \ +-- | Remove a user's tag from an album. \ +More: + +#define __search__ \ +-- | Search for an album by name. Returns album matches sorted by relevance. \ +More: + +#define __share__ \ +-- | Share an album with one or more Last.fm users or other friends. \ +More: diff --git a/docs/artist.docs b/docs/artist.docs new file mode 100644 --- /dev/null +++ b/docs/artist.docs @@ -0,0 +1,73 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __addTags__ \ +-- | Tag an album using a list of user supplied tags. \ +More: + +#define __getCorrection__ \ +-- | Use the last.fm corrections data to check whether the supplied artist has a correction to a canonical artist \ +More: + +#define __getEvents__ \ +-- | Get a list of upcoming events for this artist. \ +More: + +#define __getImages__ \ +-- | Get Images for this artist in a variety of sizes. \ +More: + +#define __getInfo__ \ +-- | Get the metadata for an artist. Includes biography. \ +More: + +#define __getPastEvents__ \ +-- | Get a paginated list of all the events this artist has played at in the past. \ +More: + +#define __getPodcast__ \ +-- | Get a podcast of free mp3s based on an artist. \ +More: + +#define __getShouts__ \ +-- | Get shouts for this artist. Also available as an rss feed. \ +More: + +#define __getSimilar__ \ +-- | Get all the artists similar to this artist. \ +More: + +#define __getTags__ \ +-- | Get the tags applied by an individual user to an artist on Last.fm. If accessed as an authenticated service /and/ you don't supply a user parameter then this service will return tags for the authenticated user. \ +More: + +#define __getTopAlbums__ \ +-- | Get the top albums for an artist on Last.fm, ordered by popularity. \ +More: + +#define __getTopFans__ \ +-- | Get the top fans for an artist on Last.fm, based on listening data. \ +More: + +#define __getTopTags__ \ +-- | Get the top tags for an artist on Last.fm, ordered by popularity. \ +More: + +#define __getTopTracks__ \ +-- | Get the top tracks by an artist on Last.fm, ordered by popularity. \ +More: + +#define __removeTag__ \ +-- | Remove a user's tag from an artist. \ +More: + +#define __search__ \ +-- | Search for an artist by name. Returns artist matches sorted by relevance. \ +More: + +#define __share__ \ +-- | Share an artist with Last.fm users or other friends. \ +More: + +#define __shout__ \ +-- | Shout in this artist's shoutbox. \ +More: diff --git a/docs/chart.docs b/docs/chart.docs new file mode 100644 --- /dev/null +++ b/docs/chart.docs @@ -0,0 +1,25 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getHypedArtists__ \ +-- | Get the hyped artists chart. \ +More: + +#define __getHypedTracks__ \ +-- | Get the hyped tracks chart. \ +More: + +#define __getLovedTracks__ \ +-- | Get the most loved tracks chart. \ +More: + +#define __getTopArtists__ \ +-- | Get the top artists chart. \ +More: + +#define __getTopTags__ \ +-- | Get top tags chart. \ +More: + +#define __getTopTracks__ \ +-- | Get the top tracks chart. \ +More: diff --git a/docs/event.docs b/docs/event.docs new file mode 100644 --- /dev/null +++ b/docs/event.docs @@ -0,0 +1,25 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __attend__ \ +-- | Set a user's attendance status for an event. \ +More: + +#define __getAttendees__ \ +-- | Get a list of attendees for an event. \ +More: + +#define __getInfo__ \ +-- | Get the metadata for an event on Last.fm. Includes attendance and lineup information. \ +More: + +#define __getShouts__ \ +-- | Get shouts for this event. \ +More: + +#define __share__ \ +-- | Share an event with one or more Last.fm users or other friends. \ +More: + +#define __shout__ \ +-- | Shout in this event's shoutbox. \ +More: diff --git a/docs/geo.docs b/docs/geo.docs new file mode 100644 --- /dev/null +++ b/docs/geo.docs @@ -0,0 +1,45 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getEvents__ \ +-- | Get all events in a specific location by country or city name. \ +More: + +#define __getMetroArtistChart__ \ +-- | Get a chart of artists for a metro. \ +More: + +#define __getMetroHypeArtistChart__ \ +-- | Get a chart of hyped (up and coming) artists for a metro. \ +More: + +#define __getMetroHypeTrackChart__ \ +-- | Get a chart of hyped (up and coming) tracks for a metro. \ +More: + +#define __getMetroTrackChart__ \ +-- | Get a chart of tracks for a metro. \ +More: + +#define __getMetroUniqueArtistChart__ \ +-- | Get a chart of the artists which make that metro unique. \ +More: + +#define __getMetroUniqueTrackChart__ \ +-- | Get a chart of the tracks which make that metro unique. \ +More: + +#define __getMetroWeeklyChartlist__ \ +-- | Get a list of available chart periods for this metro, expressed as date ranges which can be sent to the chart services. \ +More: + +#define __getMetros__ \ +-- | Get a list of valid countries and metros for use in the other webservices. \ +More: + +#define __getTopArtists__ \ +-- | Get the most popular artists on Last.fm by country. \ +More: + +#define __getTopTracks__ \ +-- | Get the most popular tracks on Last.fm last week by country. \ +More: diff --git a/docs/group.docs b/docs/group.docs new file mode 100644 --- /dev/null +++ b/docs/group.docs @@ -0,0 +1,25 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getHype__ \ +-- | Get the hype list for a group. \ +More: + +#define __getMembers__ \ +-- | Get a list of members for this group. \ +More: + +#define __getWeeklyAlbumChart__ \ +-- | Get an album chart for a group, for a given date range. If no date range is supplied, it will return the most recent album chart for this group. \ +More: + +#define __getWeeklyArtistChart__ \ +-- | Get an artist chart for a group, for a given date range. If no date range is supplied, it will return the most recent artist chart for this group. \ +More: + +#define __getWeeklyChartList__ \ +-- | Get a list of available charts for this group, expressed as date ranges which can be sent to the chart services. \ +More: + +#define __getWeeklyTrackChart__ \ +-- | Get a track chart for a group, for a given date range. If no date range is supplied, it will return the most recent track chart for this group. \ +More: diff --git a/docs/library.docs b/docs/library.docs new file mode 100644 --- /dev/null +++ b/docs/library.docs @@ -0,0 +1,41 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __addAlbum__ \ +-- | Add an album or collection of albums to a user's Last.fm library. \ +More: + +#define __addArtist__ \ +-- | Add an artist to a user's Last.fm library. \ +More: + +#define __addTrack__ \ +-- | Add a track to a user's Last.fm library. \ +More: + +#define __getAlbums__ \ +-- | A paginated list of all the albums in a user's library, with play counts and tag counts. \ +More: + +#define __getArtists__ \ +-- | A paginated list of all the artists in a user's library, with play counts and tag counts. \ +More: + +#define __getTracks__ \ +-- | A paginated list of all the tracks in a user's library, with play counts and tag counts. \ +More: + +#define __removeAlbum__ \ +-- | Remove an album from a user's Last.fm library. \ +More: + +#define __removeArtist__ \ +-- | Remove an artist from a user's Last.fm library. \ +More: + +#define __removeScrobble__ \ +-- | Remove a scrobble from a user's Last.fm library. \ +More: + +#define __removeTrack__ \ +-- | Remove a track from a user's Last.fm library. \ +More: diff --git a/docs/playlist.docs b/docs/playlist.docs new file mode 100644 --- /dev/null +++ b/docs/playlist.docs @@ -0,0 +1,9 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __addTrack__ \ +-- | Add a track to a Last.fm user's playlist. \ +More: + +#define __create__ \ +-- | Create a Last.fm playlist on behalf of a user. \ +More: diff --git a/docs/radio.docs b/docs/radio.docs new file mode 100644 --- /dev/null +++ b/docs/radio.docs @@ -0,0 +1,13 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getPlaylist__ \ +-- | Fetch new radio content periodically in an XSPF format. \ +More: + +#define __search__ \ +-- | Resolve the name of a resource into a station depending on which resource it is most likely to represent. \ +More: + +#define __tune__ \ +-- | Tune in to a Last.fm radio station. \ +More: diff --git a/docs/tag.docs b/docs/tag.docs new file mode 100644 --- /dev/null +++ b/docs/tag.docs @@ -0,0 +1,37 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getInfo__ \ +-- | Get the metadata for a tag. \ +More: + +#define __getSimilar__ \ +-- | Search for tags similar to this one. Returns tags ranked by similarity, based on listening data. \ +More: + +#define __getTopAlbums__ \ +-- | Get the top albums tagged by this tag, ordered by tag count. \ +More: + +#define __getTopArtists__ \ +-- | Get the top artists tagged by this tag, ordered by tag count. \ +More: + +#define __getTopTags__ \ +-- | Fetches the top global tags on Last.fm, sorted by popularity (number of times used). \ +More: + +#define __getTopTracks__ \ +-- | Get the top tracks tagged by this tag, ordered by tag count. \ +More: + +#define __getWeeklyArtistChart__ \ +-- | Get an artist chart for a tag, for a given date range. If no date range is supplied, it will return the most recent artist chart for this tag. \ +More: + +#define __getWeeklyChartList__ \ +-- | Get a list of available charts for this tag, expressed as date ranges which can be sent to the chart services. \ +More: + +#define __search__ \ +-- | Search for a tag by name. Returns matches sorted by relevance. \ +More: diff --git a/docs/tasteometer.docs b/docs/tasteometer.docs new file mode 100644 --- /dev/null +++ b/docs/tasteometer.docs @@ -0,0 +1,5 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __compare__ \ +-- | Get a Tasteometer score from two inputs, along with a list of shared artists. If the input is a User some additional information is returned. \ +More: diff --git a/docs/track.docs b/docs/track.docs new file mode 100644 --- /dev/null +++ b/docs/track.docs @@ -0,0 +1,77 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __addTags__ \ +-- | Tag a track using a list of user supplied tags. \ +More: + +#define __ban__ \ +-- | Ban a track for a given user profile. \ +More: + +#define __getBuyLinks__ \ +-- | Get a list of Buy Links for a particular track. \ +More: + +#define __getCorrection__ \ +-- | Use the last.fm corrections data to check whether the supplied track has a correction to a canonical track. \ +More: + +#define __getFingerprintMetadata__ \ +-- | Retrieve track metadata associated with a fingerprint id generated by the Last.fm Fingerprinter. Returns track elements, along with a 'rank' value between 0 and 1 reflecting the confidence for each match. \ +More: + +#define __getInfo__ \ +-- | Get the metadata for a track on Last.fm. \ +More: + +#define __getShouts__ \ +-- | Get shouts for this track. Also available as an rss feed. \ +More: + +#define __getSimilar__ \ +-- | Get the similar tracks for this track on Last.fm, based on listening data. \ +More: + +#define __getTags__ \ +-- | Get the tags applied by an individual user to a track on Last.fm. \ +More: + +#define __getTopFans__ \ +-- | Get the top fans for this track on Last.fm, based on listening data. \ +More: + +#define __getTopTags__ \ +-- | Get the top tags for this track on Last.fm, ordered by tag count. \ +More: + +#define __love__ \ +-- | Love a track for a user profile. \ +More: + +#define __removeTag__ \ +-- | Remove a user's tag from a track. \ +More: + +#define __scrobble__ \ +-- | Used to add a track-play to a user's profile. \ +More: + +#define __search__ \ +-- | Search for a track by track name. Returns track matches sorted by relevance. \ +More: + +#define __share__ \ +-- | Share a track twith one or more Last.fm users or other friends. \ +More: + +#define __unban__ \ +-- | Unban a track for a user profile. \ +More: + +#define __unlove__ \ +-- | Unlove a track for a user profile. \ +More: + +#define __updateNowPlaying__ \ +-- | Used to notify Last.fm that a user has started listening to a track. Parameter names are case sensitive. \ +More: diff --git a/docs/user.docs b/docs/user.docs new file mode 100644 --- /dev/null +++ b/docs/user.docs @@ -0,0 +1,101 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getArtistTracks__ \ +-- | Get a list of tracks by a given artist scrobbled by this user, including scrobble time. Can be limited to specific timeranges, defaults to all time. \ +More: + +#define __getBannedTracks__ \ +-- | Returns the tracks banned by the user. \ +More: + +#define __getEvents__ \ +-- | Get a list of upcoming events that this user is attending. \ +More: + +#define __getFriends__ \ +-- | Get a list of the user's friends on Last.fm. \ +More: + +#define __getInfo__ \ +-- | Get information about a user profile. \ +More: + +#define __getLovedTracks__ \ +-- | Get tracks loved by a user. \ +More: + +#define __getNeighbours__ \ +-- | Get a list of a user's neighbours on Last.fm. \ +More: + +#define __getNewReleases__ \ +-- | Gets a list of forthcoming releases based on a user's musical taste. \ +More: + +#define __getPastEvents__ \ +-- | Get a paginated list of all events a user has attended in the past. \ +More: + +#define __getPersonalTags__ \ +-- | Get the user's personal tags. \ +More: + +#define __getPlaylists__ \ +-- | Get a list of a user's playlists on Last.fm. \ +More: + +#define __getRecentStations__ \ +-- | Get a list of the recent Stations listened to by this user. \ +More: + +#define __getRecentTracks__ \ +-- | Get a list of the recent tracks listened to by this user. Also includes the currently playing track with the nowplaying="true" attribute if the user is currently listening. \ +More: + +#define __getRecommendedArtists__ \ +-- | Get Last.fm artist recommendations for a user. \ +More: + +#define __getRecommendedEvents__ \ +-- | Get a paginated list of all events recommended to a user by Last.fm, based on their listening profile. \ +More: + +#define __getShouts__ \ +-- | Get shouts for this user. Also available as an rss feed. \ +More: + +#define __getTopAlbums__ \ +-- | Get the top albums listened to by a user. You can stipulate a time period. Sends the overall chart by default. \ +More: + +#define __getTopArtists__ \ +-- | Get the top artists listened to by a user. You can stipulate a time period. Sends the overall chart by default. \ +More: + +#define __getTopTags__ \ +-- | Get the top tags used by this user. \ +More: + +#define __getTopTracks__ \ +-- | Get the top tracks listened to by a user. You can stipulate a time period. Sends the overall chart by default. \ +More: + +#define __getWeeklyAlbumChart__ \ +-- | Get an album chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent album chart for this user. \ +More: + +#define __getWeeklyArtistChart__ \ +-- | Get an artist chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent artist chart for this user. \ +More: + +#define __getWeeklyChartList__ \ +-- | Get a list of available charts for this user, expressed as date ranges which can be sent to the chart services. \ +More: + +#define __getWeeklyTrackChart__ \ +-- | Get a track chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent track chart for this user. \ +More: + +#define __shout__ \ +-- | Shout on this user's shoutbox. \ +More: diff --git a/docs/venue.docs b/docs/venue.docs new file mode 100644 --- /dev/null +++ b/docs/venue.docs @@ -0,0 +1,13 @@ +/* THIS FILE IS NOT INTENDED FOR USER READING. USE HADDOCK DOCUMENTATION INSTEAD. */ + +#define __getEvents__ \ +-- | Get a list of upcoming events at this venue. \ +More: + +#define __getPastEvents__ \ +-- | Get a paginated list of all the events held at this venue in the past. \ +More: + +#define __search__ \ +-- | Search for a venue by venue name. \ +More: diff --git a/liblastfm.cabal b/liblastfm.cabal --- a/liblastfm.cabal +++ b/liblastfm.cabal @@ -1,5 +1,5 @@ Name: liblastfm -Version: 0.0.3.2 +Version: 0.0.3.3 Synopsis: Wrapper to Lastfm API License: MIT License-file: LICENSE @@ -9,6 +9,7 @@ Description: Simple but complete wrapper to Lastfm API. Can send some stuff and receive reponses from Lastfm. JSON/XML parsing is an exercise for the user. Cabal-Version: >= 1.6 Build-Type: Simple +Extra-Source-Files: docs/*.docs Library Build-Depends: base >= 3 && < 5, template-haskell >= 2.5 && < 2.8, bytestring == 0.9.*, mtl == 2.*, curl == 1.3.7, pureMD5 == 2.1.*, urlencoded == 0.3.*, aeson == 0.6.*, xml == 1.3.12, utf8-string == 0.3.*