smufolib 0.3.0

New Features

• added setters for:
  • smufl.engravingDefaults
  • smufl.codepoint (value is implicitly normalized by converters.toDecimal to avoid duplication)

Bug Fixes

• fixed minor bugs in:
  • normalizers.normalizeEngravingDefaultsAttr
  • importID.py
• Fixed bugs with colors and coordinate value conversion in importAnchors.py

Documentation

• Added examples to:
  • converters.py
  • pointUtils.py
  • stdUtils.py
  • error.py
• Added documentation of external module imports to normalizers.py
• Documented read-only aspect of properties insmufl.py
• Added module docstrings to utility modules
• Replaceed list table of error templates with csv table directive in utils.rst
• Corrected broken reference links in:
  • utils.rst
  • scripts.rst
  • normalizers.py
  • cleanFont.py
  • getting_started.rst
• Corrected typo in tagline of pyproject.toml

smufolib 0.2.1

This version simply corrects the discrepant version numbering in pyprojec.toml, bringing GitHub and PYPI releases in line.

smufolib 0.2.0

Changes:

• all modules:
  • updated docstrings with new exceptions, language and cross
    references; changed variable names from explicit
    inline :code: to default role
  • updated linting directives to short form
  • updated type hints and corrected mypy errors
  • changed various parameter names to be more descriptive
• tests:
  • added test for all functions in:
    • test_stdUtils.py (except verbosePrint and doNothing)
    • test_normalizers.py
  • removed malfunctioning tests in test_pointUtils.py
  • corrected change error assertion type in test_toNumber in
    test_converters.py
• scripts:
  • refactored code with new helpers and normalizers
  • implemented stdUtils.verbosePrint() and revised messages for
    consistency.
  • revised progress bar implementation for clarity and consistency
  • changed addHelp setting to reflect new default
  • new commonParser description based on program summary line
    in docstring of program function
  • calculateEngravingDefaults.py
    • added ability to override 'textFontFamily'
    • added new table of default settings to
      calculateEngravingdefaluts() docstring
• readme.rst:
  • updated to reflect changes to getting_started.rst
• smufolib.cfg:
  • added color values to [color.marks] and [color.anchors]
  • changed comment prefix from ';' to '#'
• dev/generate_options_table.py
  • added docstring
  • moved logic to main function
  • added script excecution guard
  • corrected relative path to table file
• converters.py:
  • created toIntIfWhole() general purpose equivalent
    to calculateEngravingDefaults._normalizeMeasurement() function
• cli.py
  • changed commonParser addHelp default to True
  • added createHelpFormatter() function to combine argparse help
    formatters
  • deleted formatter from help_formatter in commonParser
  • implemented the option to add boolean arguments as on/off
    flags without default values in commonParser()
  • added customHelpers functionality to commonParser()
  • refactored commonParser() code with new nested helper functions
• error.py:
  • new module for streamlined exception handling
  • updated and added new exceptions and normalizers to all
    modules and scripts and documented extensively
  • moved URLWarning from request.py to error.py
• engravingDefaults.py
  • added override of BaseObject function raiseNotImplementedError
    to EngravingDefaults
  • replaced _normalizeMeasurement() with converters.toIntIfWhole()
• pointUtils.py
  • revised to return iterator instead of tuple and take any
    font-related object
  • fixed concatenation error in getCompositePoints function
• stdUtils.py
  • added doNothing function
  • added verbosePrint function
  • added getSummary() function to get summary lines from
    docstrings and implemented in all scripts
• smufl.py:
  • added override of BaseObject function raiseNotImplementedError
    to Smufl
  • fixed errors in 'suffix' property
  • renamed 'componentGlyphs' poperty to 'componentNames'
  • added new 'componentGlyphs' property to get ligature
    components as Glyph objects
• docs:
  • changed smufolib.cfg examples in configuration.rst to
    litteralinclude directives
  • added exclusion of raiseNotImplementedError to objects.rst
  • updatd language in request.rst
  • updated language and examples in getting_started.rst
  • updated conf.py settings

Full Changelog: v0.1.5...v0.2.0

smufolib 0.1.5

Various bug fixes and improvements:

• cli arguments moved to separate constant and documented
• constants moved to relevant modules and documented
• added customHelpers parameter to cli.commonParser to facilitate help message overrides
• generateMetadata now converts to spaces
• cleanFont now deletes zero-values
• various documentation additions and improvements

smufolib 0.1.4

Fixes issue with unistalled config file due to missing MANIFEST.in

smufolib 0.1.3

New cleanFont script, bug fixes, doc updates and other minor changes.

smufolib 0.1.2

Major improvements to entire library codebase with updated scripts, smufolib.cfg.
Added new docstrings and documentation.

smufolib 0.0.3

Changes:

• New Request class
• New setAnchors script
• Consolidation of annotations setter scripts into setAnnotation
• New command line interface cli.py
• Reformatted docstrings
• Direct import of class names (from init.py)
• Subsection oriented reformatting of configuration file smufolib.cfg.
• Package restructuring
• Numerous bug fixes and improvements