Skip to content

Commit

Permalink
Last (ha!) updates to setup.py and the two READMEs for v1.0.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
gregchapman-dev committed Feb 5, 2022
1 parent 92fa289 commit 117f764
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 8 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
6 changes: 4 additions & 2 deletions pypi_README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
27 changes: 23 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()

Expand All @@ -23,27 +23,46 @@
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='[email protected]',

classifiers=[
'Development Status :: 5 - Production/Stable',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3 :: Only',
'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',
Expand Down

0 comments on commit 117f764

Please sign in to comment.