Interact with the Audius platform in Python and the terminal
Project description
audius-py
A Python SDK and CLI for the Audius Platform.
Installation
From pip:
pip install audius-py
From source (from the root project directory):
pip install .
NOTE: In order to user the media player functionality of the SDK, you must have VLC media player installed.
Quick Usage
To create an audius
SDK instance, do:
from audius.sdk import Audius
audius = Audius()
It is recommended that you set a custom app name (the default is audius-py
).
One way to do this is via an environment variable:
export AUDIUS_APP_NAME="My_Audius_App"
Then, when you create an Audius SDK object, it will automatically use this value instead.
You can also specify an app name (and other configuration) when creating the SDK, like:
from audius.config import Config
from audius.sdk import Audius
config = Config(app_name="my_app")
sdk = Audius(config=config)
Another example config value is the host, e.g.:
export AUDIUS_HOST_NAME="https://audius.example.com"
or:
from audius.config import Config
Config(host="https://audius.exmaple.com")
If you don't specify a host, audius-py
will select a random host from the list of known hosts to the Audius app.
To see all available hosts, run the following command:
audius hosts
CLI
See all commands by doing:
audius --help
This guide will show how to stream one of the top songs on Audius directly into your terminal. First, browse top artists using the CLI:
audius users top
It should show output like this:
1: Zedd (id=XlJby)
2: Skrillex (id=eAZl3)
3: Aluna (id=5j9VM)
4: kennybeats (id=DrZwG)
5: trillsammy (id=NzMW8)
6: ODESZA (id=2oNg1)
7: noodles (id=b9w8J)
8: kayzo (id=LMdyZ)
9: Disclosure (id=E2O1R)
10: Fat Nick (id=oGKZd)
Next, select one of the user IDs by copying it and using it in the following command:
audius users tracks eAZl3
It should output track information like this:
Track: Kliptown Empyrean (id=G0wyE)
Finally, play the track by using its ID in the following command:
audius tracks play G0wyE
The song should now be streaming into your terminal! And if you really enjoy the track, you can download it by doing:
audius tracks download G0wyE song.mp3
By default, audius-py
tries to find the best player.
However, specify your player of choice using the --player
flag:
audius tracks play G0wyE --player vlc
Python SDK
Use the Python SDK directly:
from audius.sdk import Audius
sdk = Audius(app="my_app")
for artist in sdk.users.top():
print(artist["name"])
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
Built Distribution
Hashes for audius_py-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e9abffc6f2fba97ccb5648eb8b86599f05b872ca5717da7d85a6fb8c5cfd45 |
|
MD5 | 2e24469368bca3582ffd00ac105b796b |
|
BLAKE2b-256 | 49d17f422228fabf1cb79725d06278670be129ff72cf9f05effc299e56774268 |