Skip to content

Commit

Permalink
Merge branch 'master' into 21.7
Browse files Browse the repository at this point in the history
  • Loading branch information
matijakolaric committed Sep 23, 2021
2 parents 03d7193 + 8c73696 commit 68b31be
Show file tree
Hide file tree
Showing 50 changed files with 792 additions and 687 deletions.
22 changes: 0 additions & 22 deletions .do/deploy.template.yaml

This file was deleted.

3 changes: 3 additions & 0 deletions .gitattrubutes
@@ -1,2 +1,5 @@
*.V21 text eol=crlf
*.V22 text eol=crlf
*.SUB text eol=crlf
*.ISA text eol=crlf
*.ISR text eol=crlf
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/workflows/build.yml
Expand Up @@ -48,6 +48,7 @@ jobs:

- name: Test
env:
SECRET_KEY: 't569yezjg#_c^4(3_ly=pp+qehy3g$mnu6u4*nkjhvy3bqq356'
DATABASE_URL: 'postgres://postgres:postgres@localhost:${{ job.services.postgres.ports[5432] }}/postgres'
run: |
coverage run --omit=manage.py manage.py test
Expand Down
15 changes: 6 additions & 9 deletions README.rst
@@ -1,16 +1,14 @@
Django-Music-Publisher
Django-Music-Publisher - Free music publishing software
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

YOU ARE ON DEVELOPMENT BRANCH FOR 21.7

.. image:: https://github.com/matijakolaric-com/django-music-publisher/workflows/build/badge.svg?branch=21.7
.. image:: https://github.com/matijakolaric-com/django-music-publisher/workflows/build/badge.svg?branch=master
:target: https://github.com/matijakolaric-com/django-music-publisher/actions/workflows/build.yml
:alt: Build Status
.. image:: https://img.shields.io/readthedocs/django-music-publisher/21.7?logo=read-the-docs
:target: https://django-music-publisher.readthedocs.io/en/21.7/
.. image:: https://img.shields.io/readthedocs/django-music-publisher?logo=read-the-docs
:target: https://django-music-publisher.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/coveralls/github/matijakolaric-com/django-music-publisher/21.7?logo=coveralls&branch=21.7
:target: https://coveralls.io/github/matijakolaric-com/django-music-publisher?branch=21.7
.. image:: https://img.shields.io/coveralls/github/matijakolaric-com/django-music-publisher/master?logo=coveralls&branch=master
:target: https://coveralls.io/github/matijakolaric-com/django-music-publisher?branch=master
:alt: Coverage Status
.. image:: https://img.shields.io/github/license/matijakolaric-com/django-music-publisher.svg?logo=github
:target: https://github.com/matijakolaric-com/django-music-publisher/blob/master/LICENSE
Expand All @@ -30,4 +28,3 @@ Django-Music-Publisher (DMP) is open source software for **managing music metada
* Docs: https://django-music-publisher.readthedocs.io/
* Code: https://github.com/matijakolaric-com/django-music-publisher/
* PYPI: https://pypi.org/project/django-music-publisher/

4 changes: 2 additions & 2 deletions dmp_project/settings.py
Expand Up @@ -9,12 +9,12 @@
from decimal import Decimal

SOFTWARE = 'DMP.MATIJAKOLARIC.COM'
SOFTWARE_VERSION = '21.7 MADELEINE (OPEN SOURCE)'
SOFTWARE_VERSION = '21.5.1 MAYDAY (OPEN SOURCE)'

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.getenv('SECRET_KEY', get_random_secret_key())
SECRET_KEY = os.getenv('SECRET_KEY', None)

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = os.getenv('DEBUG', False)
Expand Down
2 changes: 1 addition & 1 deletion docs/LICENSE.rst
@@ -1,7 +1,7 @@
MIT License
*****************************************

Copyright (c) 2018-2020 Matija Kolarić
Copyright (c) 2018-2021 Matija Kolarić

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 4 additions & 2 deletions docs/conf.py
Expand Up @@ -27,9 +27,9 @@
author = 'Matija Kolarić'

# The short X.Y version
version = '21.7 Mayday'
version = '21.5 Mayday'
# The full version, including alpha/beta/rc tags
release = '21.5.b1'
release = '21.5.1'

rst_epilog = '''
.. |version| replace:: {}
Expand Down Expand Up @@ -103,6 +103,8 @@
'display_version': False,
}

html_favicon = 'favicon.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
Binary file added docs/favicon.ico
Binary file not shown.
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -21,6 +21,7 @@ upgrade.

introduction
installation
support
releases
LICENSE
manual
Expand Down
6 changes: 5 additions & 1 deletion docs/installation.rst
@@ -1,6 +1,11 @@
Installation, Configuration and Updating
****************************************

.. note::

The `HOME PAGE <https://dmp.matijakolaric.com>`_ of this project features a
`wizard <https://dmp.matijakolaric.com/install/>`_, described later in this document.

Django-Music-Publisher (DMP) can be installed/deployed as a stand-alone application, or used as a Python package.

Standalone Deployment
Expand Down Expand Up @@ -143,6 +148,5 @@ Other settings
------------------------------------
* ``REQUIRE_SAAN`` - Makes *Society-assigned agreement number* field required for controlled writers
* ``REQUIRE_PUBLISHER_FEE`` - Makes *Publisher Fee* field required for controlled writers
* ``ENABLE_NOTES`` - Enables notes (text field) for writers, labels and artists
* ``FORCE_CASE`` - available options are ``upper`` and ``title`` and ``smart``, converting nearly all strings to UPPER CASE or Title Case or just UPPERCASE fields to Title Case,
respectively.
4 changes: 2 additions & 2 deletions docs/introduction.rst
Expand Up @@ -28,7 +28,7 @@ Project Scope
DMP can be used out-of-the-box by most small original publishers, both for commercial (general) and
production (library) music.

Each DMP installation supports a **single original publisher**. It is not intended to be used by
Each DMP installation supports a **single publisher**. It is not intended to be used by
administrators or sub-publishers, nor by publishing companies with multiple entities (including
US publishers affiliated with multiple PROs).

Expand Down Expand Up @@ -121,4 +121,4 @@ Some publishers require more features than DMP offers and/or technical and user

One is to use commercial software. `That Green Thing <https://matijakolaric.com/thatgreenthing>`_, available as affordable Software-as-a-Service, is a built on top of Django-Music-Publisher. There are other solutions, of course.

The other option is to hire a software developer, or a developement agency, to create a custom solution to exactly match your needs. Django-Music-Publisher may be used as a starting point. Creators of Django-Music-Publisher, `That Green Thing <https://matijakolaric.com/thatgreenthing>`_ and `Python Music Metadata Libraries <https://github.com/musicmetadata>`_ should be considered, see `matijakolaric.com <https://matijakolaric.com>`_.
The other option is to hire a software developer, or a development agency, to create a custom solution to exactly match your needs. Django-Music-Publisher may be used as a starting point. Creators of Django-Music-Publisher, `That Green Thing <https://matijakolaric.com/thatgreenthing>`_ and `Python Music Metadata Libraries <https://github.com/musicmetadata>`_ should be considered, see `matijakolaric.com <https://matijakolaric.com>`_.
40 changes: 18 additions & 22 deletions docs/manual_dataimport.rst
@@ -1,29 +1,21 @@
Importing Data
==============================

Musical works metadata can be imported from CSV files.

Caveats
-------------------

Who should import data?
_______________________
.. note:: Default *Publishing Staff* permission group does not include data imports because importing data is not everyday routine.

Data imports should not be regarded as a part of the standard work flow and should not be performed by
staff users.

Failsafes, present during the manual data input and editing, may not be available during data imports.
Musical works metadata can be imported from CSV files.

.. warning:: There is no way to undo a successful import other than by restoring your database from a backup. If you don't know how to back up and restore your database, do not import data!


What is being imported?
_______________________

The import process will *add* works, including alternative titles, writers, artists, libraries
and library releases.
The import process will *add* works, including alternative titles, writers, recordings (partial), performing artists,
libraries, library releases and society work references.

No data is ever *modified*, with only one exception. A general agreement for an existing writer may be
set and a society-assigned agreement number may be added.
*set* and a society-assigned agreement number may be *added*.

Why are errors reported?
_________________________
Expand Down Expand Up @@ -52,20 +44,24 @@ How to import?
Obtaining and extending the template
__________________________________________________

Download `CSV Template <work_import_template.csv>`_.
You can edit it in Excel or another spreadsheet tool.
Download the CSV template from the `Add Data Import` view.
You can edit it in Excel or another spreadsheet tool.

Alternativelly, you can go to `CWR Tools - CSV to CWR <https://cwr.tools/csv_to_cwr/>`_,
and download the template in Excel format. You still need to save it as CSV before uploading to
DMP.

It contains 4 columns for alternative titles, as well as
4 column sets for writers and 4 column sets for artists.
It contains 6 columns for alternative titles, as well as
6 column sets for writers, recordings and artists.

For another writer column set, add all of:
``Writer 5 Last``, ``Writer 5 First``, ``Writer 5 IPI``, ``Writer 5 PRO``, ``Writer 5 Role``,
``Writer 5 Share``, ``Writer 5 Controlled``, ``Writer 5 SAAN``.
``Writer 7 Last``, ``Writer 7 First``, ``Writer 7 IPI``, ``Writer 7 PRO``, ``Writer 7 Role``,
``Writer 7 Manuscript Share``, ``Writer 7 Controlled``, ``Writer 7 SAAN``.

You can add as many writer-, artist- and alternative-title-sets as you require. Just keep incrementing
You can add as many writer-, recording-, artist- and alternative-title-sets as you require. Just keep incrementing
the counter.

Note that this file has the same form as CSV exports, described in :ref:`exporting_csv`.
Note that this file has a subset of columns described in :ref:`exporting_csv`.

Filling out the template
______________________________
Expand Down
7 changes: 2 additions & 5 deletions docs/manual_work.rst
Expand Up @@ -299,12 +299,9 @@ Exporting CSV
++++++++++++++++++++++++++

Select several (or all) works in the ``musical work list`` view, select the ``Export selected works (CSV)`` action and
click ``Go``. A CSV file will be downloaded, containing **only basic** information about your works.
click ``Go``. A CSV file will be downloaded, containing **most** information about your works.

It contains no data about the controlling publisher (you) and recordings, including recording
artists, labels, tracks and releases.

This CSV format is the same as the one used for :doc:`Importing data <manual_dataimport>`.
This CSV format is similar to the one used for :doc:`Importing data <manual_dataimport>`.

CWR Exporting Wizard
++++++++++++++++++++
Expand Down
44 changes: 44 additions & 0 deletions docs/modules.rst
Expand Up @@ -34,6 +34,13 @@ music\_publisher.apps
:members:
:show-inheritance:

music\_publisher.societies
----------------------------------

.. automodule:: music_publisher.societies
:members:
:show-inheritance:

music\_publisher.validators
----------------------------------

Expand Down Expand Up @@ -62,6 +69,43 @@ music\_publisher.cwr_templates
:members:
:show-inheritance:

music\_publisher.templatetags
-------------------------------------

.. automodule:: music_publisher.templatetags
:members:
:show-inheritance:

music\_publisher.templatetags.cwr\_filters
--------------------------------------------------------------

.. automodule:: music_publisher.templatetags.cwr_filters
:members:
:show-inheritance:

music\_publisher.templatetags.cwr\_generators
--------------------------------------------------------------

.. automodule:: music_publisher.templatetags.cwr_generators
:members:
:show-inheritance:

music\_publisher.templatetags.dmp\_dashboard
--------------------------------------------------------------

.. automodule:: music_publisher.templatetags.dmp_dashboard
:members:
:show-inheritance:


music\_publisher.forms
-----------------------------

.. automodule:: music_publisher.forms
:members:
:show-inheritance:


music\_publisher.admin
-----------------------------

Expand Down

0 comments on commit 68b31be

Please sign in to comment.