Setup
The only external dependencies needed are:
- Python 3.13.0 or higher.
ffmpeg.libopus.libffi-devel.
Then just install the bot from PyPI with pipx:
pipx install disopy
Or directy with pip:
python3 -m pip install disopy
Finally generate a basic config file:
disopy --generate-config
It will be located at ${XDG_CONFIG_DIR}/disopy/config.toml (in most cases $HOME/.config/disopy/config.toml), remember to edit it with your configuration values.
Docker
There is an official Docker container with name ghcr.io/kutu-dev/disopy. An example compose file is also provided.
Running the bot
The bot needs two environment variables:
DISOPY_SUBSONIC_PASSWORD
The password to be send to the Subsonic REST API. Usually it'll be the same that you use to login in the WebUI of your Subsonic compatible server.
DISOPY_DISCORD_TOKEN
The token to be used when authenticating to the Discord API. To set up a bot on Discord follow this tutorial:
- Go to the Discord Developer Portal.
- Create a new application.
- On the application go to
Bot. - Enable
Message Content Intent. - And click on
Reset Tokento get string you should put on the env variable.
How to create an invite link
- Go to the Discord Developer Portal.
- Enter your bot application.
- On the application go to
OAuth2. - Copy your
Client ID. - Go to this preconfigured Discord Permissions Calculator.
- Paste your
Client IDon the bottom. - Copy and share your invite link at the bottom of the web!
And then just start the bot!
DISOPY_SUBSONIC_PASSWORD=foo DISOPY_DISCORD_TOKEN=bar disopy
Contributing
If you are interested in fixing bugs or adding new features please check the contributing guide.
Acknowledgements
- Created with :heart: by Jorge "Kutu" Dobón Blanco.
- JmTexas19: Creator of Subrift, project forked that served as a base for Disopy.
- iGieri: Fix issue #1.
- outmaneuver: Fix issue #3.
- An May (YUR0ii): Make HTTPS optional.
Metadata
Release files for disopy 2.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| disopy-2.2.3.tar.gz | 21.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| disopy-2.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.1 kB
Release files / disopy-2.2.3.tar.gz
| Download URL | disopy-2.2.3.tar.gz |
|---|---|
| Size | 21.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51fcc71fa09728b2d13f22e00599909adbdf161db24cb00ab9838243736db450
|
|
BLAKE2b-256 checksum How to use checksums |
23150053d28d46053a30f7938eaac12f4dabe0e81c01b087a4f72629518e9891
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 27, 2024.
Transparency logRelease files / disopy-2.2.3-py3-none-any.whl
| Download URL | disopy-2.2.3-py3-none-any.whl |
|---|---|
| Size | 24.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0bc4cc7b44eca838b142c05bdeee70992aadd527747f90661d403dbd2c550471
|
|
BLAKE2b-256 checksum How to use checksums |
f7f39b47e1555901245e4b789d5d8f583124d9b9599a3891b196eef5724ea211
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 27, 2024.
Transparency log