Skip to main content

Python Soundcloud API

Project description

Soundcloud-lib

This Soundcloud API doesn't require a user-provided client ID to function because it scrapes one from public soundcloud pages.

Version

Features

  • Can resolve tracks and playlists from URLs
  • Can download and write the MP3 representation of a Track to a file
  • Fetches and writes mp3 metadata (Album artist, title, artwork)
  • Can fetch entire playlists of tracks
  • Asyncio support through sclib.asyncio

Installation

This library is installable as a pip package.

pip install soundcloud-lib

Saving an mp3 to a file.

This will write the ID3 tags for album artist, track title AND will embed the album artwork into the mp3.

from sclib import SoundcloudAPI, Track, Playlist

# do not pass a Soundcloud client ID that did not come from this library, but you can save a client_id that this lib found and reuse it
api = SoundcloudAPI()  
track = api.resolve('https://soundcloud.com/itsmeneedle/sunday-morning')

assert type(track) is Track

filename = f'./{track.artist} - {track.title}.mp3'

with open(filename, 'wb+') as file:
    track.write_mp3_to(file)

Fetch a playlist

from sclib import SoundcloudAPI, Track, Playlist

api = SoundcloudAPI()
playlist = api.resolve('https://soundcloud.com/playlist_url')

assert type(playlist) is Playlist

for track in playlist.tracks:
    filename = f'./{track.artist} - {track.title}.mp3'
    with open(filename, 'wb+') as file:
        track.write_mp3_to(file)

Asyncio Support

from sclib.asyncio import SoundcloudAPI, Track

api = SoundcloudAPI()
track = await api.resolve('https://soundcloud.com/user/track')

assert type(track) is Track

filename = f'{track.artist} - {track.title}.mp3'

with open(filename, 'wb+') as file:
    await track.write_mp3_to(file)

Fetch a playlist

from sclib.asyncio import SoundcloudAPI, Track, Playlist

api = SoundcloudAPI()
playlist = await api.resolve('https://soundcloud.com/playlist_url')

assert type(playlist) is Playlist

for track in playlist.tracks:
    filename = f'./{track.artist} - {track.title}.mp3'
    with open(filename, 'wb+') as file:
        await track.write_mp3_to(file)

Write Album Name or Track Number

from sclib import SoundcloudAPI, Track, Playlist

playlist = SoundcloudAPI().resolve("https://soundcloud.com/user/sets/playlist_name")

for track_number, track in enumerate(playlist):
    track.track_no = track_number
    track.album = playlist.title
    with open(f"{track.artist} - {track.title}.mp3", "wb+") as file:
        track.write_mp3_to(file)

Known Limitations

This library cannot download tracks that are not marked "Downloadable".

"Downloadable" tracks have an MP3 representation while non-"Downloadable" ones only have HLS representations. I would like to add HLS assembly to this library in the future.

Bugs or Features

Please report any and all bugs using the issues tab.

Feel free to request new features too.

Contributing

Please feel free to submit a PR with your changes. PRs will only be accepted after a passing build. You can make sure your changes pass the build stage by running make lint and make test locally without errors. Code should be 10/10 quality for linting and all tests should pass.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soundcloud-lib-0.6.1.tar.gz (9.1 kB view details)

Uploaded Source

File details

Details for the file soundcloud-lib-0.6.1.tar.gz.

File metadata

  • Download URL: soundcloud-lib-0.6.1.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for soundcloud-lib-0.6.1.tar.gz
Algorithm Hash digest
SHA256 85169d6e7e39cd39ed3068ebf7d54a1a6fa865959203b50bd6829074be346e64
MD5 3a31bf005059dc09cdfa9c2577d89c20
BLAKE2b-256 c5fae4c9ecc28be51ac6c69ad36a5d5e202483c23ff8f7257c8f1762e3179834

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page