diff --git a/README.md b/README.md index 014fa53..2a70eeb 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # musicdiff -A Python3 package (and command-line tool) for computing and visualizing the differences between two music scores. +A Python3 package (and command-line tool) for computing and visualizing the notation differences between two music scores. + +musicdiff is focused on visible notation differences, not only on audible musical differences. For example, two tied eighth notes are considered different from a single quarter note. And two beamed 16th notes are considered different from two unbeamed 16th notes. This makes musicdiff particularly useful for assessing the results of Optical Music Recognition software. musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/music-score-diff.git) by [Francesco Foscarin](https://github.com/fosfrancesco). ## Setup -Depends on music21 (best with v7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore). +Depends on music21 (version 7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore). ## Usage On the command line: diff --git a/pypi_README.md b/pypi_README.md index 75d5c08..c5a512e 100644 --- a/pypi_README.md +++ b/pypi_README.md @@ -1,11 +1,13 @@ # musicdiff -A Python3 package (and command-line tool) for computing and visualizing the differences between two music scores. +A Python3 package (and command-line tool) for computing and visualizing the notation differences between two music scores. + +musicdiff is focused on visible notation differences, not only on audible musical differences. For example, two tied eighth notes are considered different from a single quarter note. And two beamed 16th notes are considered different from two unbeamed 16th notes. This makes musicdiff particularly useful for assessing the results of Optical Music Recognition software. musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/music-score-diff.git) by [Francesco Foscarin](https://github.com/fosfrancesco). ## Setup -Depends on music21 (best with v7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore). +Depends on music21 (version 7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore). ## Usage On the command line: diff --git a/setup.py b/setup.py index ae27d60..3e10309 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ from setuptools import setup, find_packages import pathlib -musicdiffversion = '1.0.1b2' +musicdiffversion = '1.0.1' here = pathlib.Path(__file__).parent.resolve() @@ -23,12 +23,16 @@ setup( name='musicdiff', version=musicdiffversion, - description='music score diff package', + + description='A music score notation diff package', long_description=long_description, long_description_content_type='text/markdown', + url='https://github.com/gregchapman-dev/musicdiff', + author='Greg Chapman', author_email='gregc@mac.com', + classifiers=[ 'Development Status :: 5 - Production/Stable', 'License :: OSI Approved :: MIT License', @@ -36,14 +40,29 @@ 'Operating System :: OS Independent', 'Natural Language :: English', ], - keywords='music, score, notation, diff, compare, OMR, assessment, music21', + + keywords=[ + 'music', + 'score', + 'notation', + 'diff', + 'compare', + 'OMR', + 'Optical Music Recognition', + 'assessment', + 'comparison', + 'music21', + ], + packages=find_packages(), python_requires='>=3.7', + install_requires=[ - 'music21>=6.7', + 'music21>=7.1', 'numpy', ], + project_urls={ 'Documentation': 'https://gregchapman-dev.github.io/musicdiff', 'Source': 'https://github.com/gregchapman-dev/musicdiff',