Release v1.0.20230224

1.0.20230224 (2023-02-25)

⚠ BREAKING CHANGES

• smil-ectomy
• avoid using dict for things that are lists
• new web API version
• use .ras not .xml
• no more smil
• update to .ras file extension in output

Features

• a simple DTD for standalone readalongs (f94174b)
• add time and dur attributes to w (5e92b91)
• avoid using dict for things that are lists (20fc1a5)
• basically s/tei/readalong/gi (5465d22)
• capture the logs from /assemble endpoint (5713abc)
• introduce better CORS environment variables (1eb5d74), closes #146
• introduce better CORS environment variables (d8ab4cf), closes #146
• log message to say we are in development mode (a1f53bc)
• new web API version (bec85ee)
• no more smil (eb9d25b)
• output to .ras (8d4f76b)
• refine the DTD somewhat (b7285f5)
• set our .readalong format to version 1.0 for publication (2f0da60)
• smil-ectomy (24dabbd)
• update .ras to .readalong (525facf)
• update to .ras file extension in output (163de15)
• update to href= in readalong component (79b8a64)
• use .ras not .xml (09b34d6)

Bug Fixes

• accept and use dur not duration (b65a5dd)
• add class to DTD and update version (903ddd5)
• add xml:lang and anchors everywhere (7192fa6)
• address XML external entity expansion vulnerabilities (d0c57f3)
• correct main guard in test_package_urls.py (fbda869)
• don't create blank pages (54d23d5), closes #136
• filter ASCII langs from the Studio-Web via web_api (e63406f)
• frantic and unsuccessful attempts to make CORS work (52b9a39)
• handle requests.get() timeouts correctly (464a3cc)
• make test case valid (fdd8cb0)
• only wait 10 seconds for JS_ and FONT_BUNDLE_URLs (a67e360)
• tell the user why their config.json is not valid (4deb32e)
• test and fix load_xml_zip (10718dc)
• try validating a different way to see if the CodeQL warning goes away (6e62789)
• update bundle.css and bundle.js to @readalongs/[email protected] (a462688)
• update package URLs (4eebbb3)
• use .xml not .ras to avoid breaking MIME guessing (19fc2f1)
• validate path request by /file endpoint in views.py (5ba27ad)
• when g2p fails completely, send the log with the exception (f772eec)
• woohps tyop (367e539)
• words may not be aligned (e.g. do-not-align) (586154d)
• docs: fix formatting of /langs endpoint sample output (7059978)
• write out a version number in the .readalong format (2e28d86)

Tests

• add a couple more tests (c68f06e)
• add bogus alignments (959bda4)
• add test of RAS XML validation (7dd3072)
• appease the codecov beast (5dac6f3)
• basically s/tei/readalong/gi (4c1ed5a)
• not sure why "lang" not "xml:lang" (96ae876)
• test new web API (adb6d3e)
• there is no text + alingment ther eis only readalong (5e623b7)
• tolerate unpkg timeouts as non-failures (dbd3942)
• update .ras to .readalong (300a622)
• update for new component and file format (1d2ca59)

Code Refactoring

• capture logs with a context manager (87716bd)
• change master branch name to main (3b64837)
• move all etree.parse calls to a single well-tested function (c2996b8)
• reformat (1874e96)
• webapi: change back to v1 (c80224a)
• remove deprecated studio (692d630)
• switch to .readalong extension (c4c6c89)

Continuous Integration

• activate CodeQL code analysis (7f8761b)
• combine debug and non-debug web_api tests (214b081)
• only run CodeQL on cron and push to master and release (6d44875)
• submit PR instead of pushing version bump (6f181a7), closes #83
• test web server in development mode too (e7d892c)

Documentation

• setup: improve pypi (ec00b4f)
• better document how to install and run the Web API (996a96a)
• clean up /langs doc (43dd309)
• document new environment variables (34b4435)
• remove smil and add ras (7be9d7e)
• update .ras to .readalong (b9bf023)