From f8b46bcc3ae3449846d0f2af4d24f6dc3c42ab00 Mon Sep 17 00:00:00 2001 From: "Yuma.M" Date: Fri, 29 Apr 2016 20:15:47 +0900 Subject: [PATCH] Create pychord package --- LICENSE | 222 ++++------------------------------------ README.md | 22 +++- pychord/__init__.py | 1 + pychord/parser.py | 34 ++++++ pychord/pychord.py | 32 ++++++ pychord/qualities.py | 57 +++++++++++ pychord/quality_list.py | 42 ++++++++ pychord/utils.py | 49 +++++++++ setup.cfg | 2 + setup.py | 36 +++++++ 10 files changed, 295 insertions(+), 202 deletions(-) create mode 100644 pychord/__init__.py create mode 100644 pychord/parser.py create mode 100644 pychord/pychord.py create mode 100644 pychord/qualities.py create mode 100644 pychord/quality_list.py create mode 100644 pychord/utils.py create mode 100644 setup.cfg create mode 100644 setup.py diff --git a/LICENSE b/LICENSE index 8dada3e..de682fe 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,21 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +The MIT License (MIT) + +Copyright (c) 2015 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 2805ce5..a63f3d7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # pychord -Handle chord in python +A library to handle musical chords in python. +If you want to know more about chord, please see https://en.wikipedia.org/wiki/Chord_(music) + +## Installation + +```sh +$ pip install pychord +``` + +## Usage + +```python +>>> from pychord import Chord +>>> c = Chord("Am7") +>>> print c.info() +Am7 +root=A +quality=m7 +appended=[] +on=None +``` diff --git a/pychord/__init__.py b/pychord/__init__.py new file mode 100644 index 0000000..1ff96cb --- /dev/null +++ b/pychord/__init__.py @@ -0,0 +1 @@ +from pychord import Chord diff --git a/pychord/parser.py b/pychord/parser.py new file mode 100644 index 0000000..374fac9 --- /dev/null +++ b/pychord/parser.py @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- + +from qualities import Quality +from quality_list import QUALITY_DICT +from utils import NOTE_VAL_DICT + + +def parse(chord): + if len(chord) > 1 and chord[1] in ("b", "#"): + root = chord[:2] + rest = chord[2:] + else: + root = chord[:1] + rest = chord[1:] + check_note(root, chord) + on_chord_idx = rest.find("/") + if on_chord_idx >= 0: + on = rest[on_chord_idx + 1:] + rest = rest[:on_chord_idx] + check_note(on, chord) + else: + on = None + if rest in QUALITY_DICT: + quality = Quality(rest) + else: + raise ValueError("Invalid chord {}: Unknown quality {}".format(chord, rest)) + appended = [] + return root, quality, appended, on + + +def check_note(note, chord): + if note not in NOTE_VAL_DICT: + raise ValueError("Invalid chord {}: Unknown note {}".format(chord, note)) + return True diff --git a/pychord/pychord.py b/pychord/pychord.py new file mode 100644 index 0000000..d3e4441 --- /dev/null +++ b/pychord/pychord.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- + +from __future__ import print_function + +from parser import parse + + +class Chord(object): + def __init__(self, chord): + self.chord = chord + self.root, self.quality, self.appended, self.on = "", "", "", "" + self._parse(chord) + + def __unicode__(self): + return self.chord + + def __str__(self): + return self.chord + + def info(self): + return """{} +root={} +quality={} +appended={} +on={}""".format(self.chord, self.root, self.quality, self.appended, self.on) + + def _parse(self, chord): + root, quality, appended, on = parse(chord) + self.root = root + self.quality = quality + self.appended = appended + self.on = on diff --git a/pychord/qualities.py b/pychord/qualities.py new file mode 100644 index 0000000..45ceae9 --- /dev/null +++ b/pychord/qualities.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- + +from quality_list import QUALITY_DICT +from utils import note_to_val + + +class Quality(object): + def __init__(self, quality): + if quality not in QUALITY_DICT: + raise ValueError("unknown quality {}".format(quality)) + self.quality = quality + self.components = QUALITY_DICT[quality] + + def __unicode__(self): + return self.quality + + def __str__(self): + return self.quality + + def get_components(self, root='C'): + root_val = note_to_val(root) + components = [v + root_val for v in self.components] + return components + + def append_on_chord(self, on_chord, root): + """Append on chord + + To create Am7/G + q = Quality('m7') + q.append_on_chord('G', root='A') + """ + root_val = note_to_val(root) + on_chord_val = note_to_val(on_chord) - root_val + for idx, val in enumerate(self.components): + if val % 12 == on_chord_val: + scale = val / 12 + self._rotate_components(idx, scale) + break + if on_chord_val > root_val: + on_chord_val -= 12 + if on_chord_val not in self.components: + self.components.insert(0, on_chord_val) + + def _rotate_components(self, stop_idx, scale): + for idx, val in enumerate(self.components[:stop_idx]): + self.components[idx] += (scale + 1) * 12 + + def append_note(self, note, root, scale=0): + root_val = note_to_val(root) + note_val = note_to_val(note) - root_val + scale * 12 + if note_val not in self.components: + self.components.append(note_val) + self.components.sort() + + def append_notes(self, notes, root, scale=0): + for note in notes: + self.append_note(note, root, scale) diff --git a/pychord/quality_list.py b/pychord/quality_list.py new file mode 100644 index 0000000..e845f9d --- /dev/null +++ b/pychord/quality_list.py @@ -0,0 +1,42 @@ +# -*- coding: utf-8 -*- + +QUALITY_DICT = { + # chords consist of 3 notes + '': [0, 4, 7], + 'maj': [0, 4, 7], + 'm': [0, 3, 7], + 'min': [0, 3, 7], + 'dim': [0, 3, 6], + 'arg': [0, 4, 8], + 'sus2': [0, 2, 7], + 'sus4': [0, 5, 7], + # 4 notes + '6': [0, 4, 7, 9], + '7': [0, 4, 7, 10], + '7-5': [0, 4, 6, 10], + '7+5': [0, 4, 8, 10], + '7sus4': [0, 5, 7, 10], + 'm7': [0, 3, 7, 10], + 'm7-5': [0, 3, 6, 10], + 'dim6': [0, 3, 6, 9], + 'M7': [0, 4, 7, 11], + 'M7+5': [0, 4, 8, 11], + 'mM7': [0, 3, 7, 11], + 'add9': [0, 4, 7, 14], + '2': [0, 4, 7, 14], + 'add11': [0, 4, 7, 17], + '4': [0, 4, 7, 17], + # 5 notes + '6/9': [0, 4, 7, 9, 14], + '9': [0, 4, 7, 10, 14], + 'm9': [0, 3, 7, 10, 14], + 'M9': [0, 4, 7, 11, 14], + '9sus4': [0, 5, 7, 10, 14], + '7-9': [0, 4, 7, 10, 13], + '7+9': [0, 4, 7, 10, 15], + '11': [0, 7, 10, 14, 17], + '7+11': [0, 4, 7, 10, 18], + '7-13': [0, 4, 7, 10, 20], + # 6 notes + '13': [0, 4, 7, 10, 14, 21], +} diff --git a/pychord/utils.py b/pychord/utils.py new file mode 100644 index 0000000..4ed7e52 --- /dev/null +++ b/pychord/utils.py @@ -0,0 +1,49 @@ +# -*- coding: utf-8 -*- + +NOTE_VAL_DICT = { + 'Ab': 8, + 'A': 9, + 'A#': 10, + 'Bb': 10, + 'B': 11, + 'Cb': 11, + 'C': 0, + 'C#': 1, + 'Db': 1, + 'D': 2, + 'D#': 3, + 'Eb': 3, + 'E': 4, + 'F': 5, + 'F#': 6, + 'Gb': 6, + 'G': 7, + 'G#': 8, +} + + +VAL_NOTE_DICT = { + 0: ['C'], + 1: ['Db', 'C#'], + 2: ['D'], + 3: ['Eb', 'D#'], + 4: ['E'], + 5: ['F'], + 6: ['F#', 'Gb'], + 7: ['G'], + 8: ['Ab', 'G#'], + 9: ['A'], + 10: ['Bb', 'A#'], + 11: ['B', 'Cb'] +} + + +def note_to_val(note): + if note not in NOTE_VAL_DICT: + raise ValueError("Unknown note {}".format(note)) + return NOTE_VAL_DICT[note] + + +def val_to_note(val): + val = val % 12 + return VAL_NOTE_DICT[val][0] diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..3c6e79c --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[bdist_wheel] +universal=1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..68dc18d --- /dev/null +++ b/setup.py @@ -0,0 +1,36 @@ +from setuptools import setup, find_packages +version = '0.0.1' + +try: + import pypandoc + read_md = lambda f: pypandoc.convert(f, 'rst') +except ImportError: + print("warning: pypandoc module not found, could not convert Markdown to RST") + read_md = lambda f: open(f, 'r').read() + +setup( + name='pychord', + version=version, + description="A library to handle musical chords in python.", + classifiers=[ + "Development Status :: 3 - Alpha", + "Environment :: Console", + "Intended Audience :: Developers", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Software Development :: Libraries :: Python Modules", + "Topic :: Multimedia :: Sound/Audio", + "Topic :: Utilities", + "License :: OSI Approved :: MIT License", + ], + keywords='music chord', + author='Yuma Mihira', + author_email='info@yurax2.com', + url='https://github.com/yuma-m/pychord', + license='MIT', + packages=find_packages(exclude=['tests']), + include_package_data=True, + zip_safe=True, + long_description=read_md('README.md'), +)