Skip to main content

SMW Music README

Bandit status Lint status MYPY status Unit test status Code Coverage PyPI - Package Version PyPI - Python Version Documentation Status PyPI - Status REUSE Status PyPI - License python-style

Library and utilities for generating AddMusicK-compatible MML files from MusicXML.

The tooling has only been tested with exported MusicXML files from MuseScore 3.6.2, but it should work with outputs from other music notation software. Output files are tested against AddMusicK 1.0.8.

The software (and especially the libraries) are beta. APIs may change at any time for any/no reason.

Local Installation

Use pip to install smw_music:

pip install smw_music

Or install from source using poetry:

pip install poetry
git clone https://github.com/com-posers-pit/smw_music
cd smw_music
poetry install --only main

Usage

After installing the tools, convert a MusicXML file song.mxl to an AddMusicK MML file song.txt by running the following command:

smw_music_xml_to_amk  song.xml song.txt

See Examples in the official documentation for more detailed examples and a feature list.

Contributing

Pull requests are welcome. See our Contributor Guide for information.

License

The SMW Music Python Project Copyright (C) 2021 The SMW Music Python Project Authors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

A copy of the AGPL v3.0 is available here

Acknowledgements

Metadata

Release files for smw-music 0.3.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for smw-music 0.3.12
File Size Uploaded
smw_music-0.3.12.tar.gz 301.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for smw-music 0.3.12
File Interpreter ABI Platform
smw_music-0.3.12-py3-none-any.whl Python 3 none any Details

Total release size: 631.8 kB

Release files / smw_music-0.3.12.tar.gz

Download URL smw_music-0.3.12.tar.gz
Size 301.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d860aea0008f7b59f432cebcea5e3f1a20d27dcefab565239ef36370bb66f603
BLAKE2b-256 checksum
How to use checksums
eb03882dae8e84b42c89d8b4f5db0926165d1db84a0ddbe0423fb727c8dd2c90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.2 Linux/5.15.0-1041-azure

Release files / smw_music-0.3.12-py3-none-any.whl

Download URL smw_music-0.3.12-py3-none-any.whl
Size 330.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d55662c311354d03f34287f3f8682e5dd85958b03975625e377927163110ad43
BLAKE2b-256 checksum
How to use checksums
d4ce5055fa4c8275ab1ba58989700d320e9bba022d4827eed38519cb842802de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.2 Linux/5.15.0-1041-azure

Release history Release notifications | RSS feed

This release

0.3.12 This release

2 release files

0.3.11

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page