Skip to content

Commit 117f764

Browse files
Last (ha!) updates to setup.py and the two READMEs for v1.0.1.
1 parent 92fa289 commit 117f764

File tree

3 files changed

+31
-8
lines changed

3 files changed

+31
-8
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# musicdiff
2-
A Python3 package (and command-line tool) for computing and visualizing the differences between two music scores.
2+
A Python3 package (and command-line tool) for computing and visualizing the notation differences between two music scores.
3+
4+
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.
35

46
musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/music-score-diff.git)
57
by [Francesco Foscarin](https://github.com/fosfrancesco).
68

79
## Setup
8-
Depends on music21 (best with v7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore).
10+
Depends on music21 (version 7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore).
911

1012
## Usage
1113
On the command line:

pypi_README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# musicdiff
2-
A Python3 package (and command-line tool) for computing and visualizing the differences between two music scores.
2+
A Python3 package (and command-line tool) for computing and visualizing the notation differences between two music scores.
3+
4+
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.
35

46
musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/music-score-diff.git)
57
by [Francesco Foscarin](https://github.com/fosfrancesco).
68

79
## Setup
8-
Depends on music21 (best with v7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore).
10+
Depends on music21 (version 7) and numpy. You also will need to configure music21 to display a musical score (e.g. with MuseScore).
911

1012
## Usage
1113
On the command line:

setup.py

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from setuptools import setup, find_packages
1414
import pathlib
1515

16-
musicdiffversion = '1.0.1b2'
16+
musicdiffversion = '1.0.1'
1717

1818
here = pathlib.Path(__file__).parent.resolve()
1919

@@ -23,27 +23,46 @@
2323
setup(
2424
name='musicdiff',
2525
version=musicdiffversion,
26-
description='music score diff package',
26+
27+
description='A music score notation diff package',
2728
long_description=long_description,
2829
long_description_content_type='text/markdown',
30+
2931
url='https://github.com/gregchapman-dev/musicdiff',
32+
3033
author='Greg Chapman',
3134
author_email='[email protected]',
35+
3236
classifiers=[
3337
'Development Status :: 5 - Production/Stable',
3438
'License :: OSI Approved :: MIT License',
3539
'Programming Language :: Python :: 3 :: Only',
3640
'Operating System :: OS Independent',
3741
'Natural Language :: English',
3842
],
39-
keywords='music, score, notation, diff, compare, OMR, assessment, music21',
43+
44+
keywords=[
45+
'music',
46+
'score',
47+
'notation',
48+
'diff',
49+
'compare',
50+
'OMR',
51+
'Optical Music Recognition',
52+
'assessment',
53+
'comparison',
54+
'music21',
55+
],
56+
4057
packages=find_packages(),
4158

4259
python_requires='>=3.7',
60+
4361
install_requires=[
44-
'music21>=6.7',
62+
'music21>=7.1',
4563
'numpy',
4664
],
65+
4766
project_urls={
4867
'Documentation': 'https://gregchapman-dev.github.io/musicdiff',
4968
'Source': 'https://github.com/gregchapman-dev/musicdiff',

0 commit comments

Comments
 (0)