Installation and Upgrading

Note

Heroku announced that they are discontinuing all free services on 28th of November 2022, and deleting all existing free databases. (https://devcenter.heroku.com/changelog-items/2461)

Note

Due to the situation, Matija Kolarić temporarily removed the pre-installation wizard. (https://dmp.matijakolaric.com/install)

Installation

Code repository for DMP can be found at https://github.com/matijakolaric-com/django-music-publisher.

Without the pre-installation wizard, which is not available for the time being, installation of DMP requires significant technical skills.

DMP - Django-Music-Publisher is based on Django, which can be installed on Windows, Mac and Linux PCs and servers. For more information, consult the official Deploying Django documentation.

If you plan to use Django-Music-Publisher as one of the apps in your Django project, there is nothing special about it:

pip install --upgrade django_music_publisher

Add music_publisher.apps.MusicPublisherConfig to INSTALLED_APPS. Almost everything goes through the Django Admin. The only exception is royalty calculation, which has to be added to urls.py

from music_publisher.royalty_calculation import RoyaltyCalculationView

urlpatterns = [
    ...
    path('royalty_calculation/', RoyaltyCalculationView.as_view(), name='royalty_calculation'),
]

There are several required settings.

Settings

Secret key

Django requires SECRET_KEY to be set.

Publisher-related settings

• PUBLISHER_NAME - Name of the publisher using Django-Music-Publisher, required
• PUBLISHER_IPI_BASE - Publisher’s IPI Base Number, rarely used
• PUBLISHER_IPI_NAME - Publisher’s IPI Name Number, required
• PUBLISHER_CODE - Publisher’s CWR Delivery code, defaults to 000, which is not accepted by CMOs, but may be accepted by (sub-)publishers.
• PUBLISHER_SOCIETY_PR - Publisher’s performance collecting society (PRO) numeric code, required
• PUBLISHER_SOCIETY_MR - Publisher’s mechanical collecting society (MRO) numeric code
• PUBLISHER_SOCIETY_SR - Publisher’s synchronization collecting society numeric code, rarely used

For the list of codes, please have a look at societies.csv file in the music_publisher folder of the code repository.

Agreement-related settings

• PUBLISHING_AGREEMENT_PUBLISHER_PR - Performance share transferred to the publisher, default is ‘0.5’ (50%)
• PUBLISHING_AGREEMENT_PUBLISHER_MR - Mechanical share transferred to the publisher, default is ‘1.0’ (100%)
• PUBLISHING_AGREEMENT_PUBLISHER_SR - Synchronization share transferred to the publisher, default is ‘1.0’ (100%)

S3 storage

Recommended S3 provider is Digital Ocean, it is simpler to set up and more affordable than AWS. They call S3 Spaces.

For Digital Ocean, you need to set up only four config (environment) variables.

• S3_REGION (alias for AWS_S3_REGION_NAME) and S3_BUCKET (alias for AWS_STORAGE_BUCKET_NAME), you get them when you set up your Spaces, and

• S3_ID (alias for AWS_ACCESS_KEY_ID) and S3_SECRET (alias for AWS_SECRET_ACCESS_KEY), you get them when you generate your Spaces API key.

If you want to use AWS or some other S3 provider, the full list of settings is available here.

Other options

• OPTION_FORCE_CASE - available options are upper, title and smart, converting nearly all strings to UPPER CASE or Title Case or just UPPERCASE fields to Title Case, respectively.
• OPTION_FILES - enables support for file uploads (audio files and images), using local file storage (PC & VPS)