sus-io 0.2.1

A SUS (Sliding Universal Score) parser and generator.

sus-io

A SUS (Sliding Universal Score) parser and generator.

Functionality

• Parse sus into tick-based objects.
• Allow json output.

Usage

sus.loads(data: str)

import sus

print(sus.loads("#00002: 4\n#BPM01: 120\n#00008: 01"))

sus.load(fp: TextIO)

import sus

with open("score.sus", "r") as f:
    score = sus.load(f)
    print(score)

Score(...).to_json(...), Score.from_json(...)

import sus
from sus import Score

with open("score.sus", "r") as fi, open("score.json", "w") as fo:
    score = sus.load(fi)
    json = score.to_json(indent=4)
    fo.write(json)

    print(Score.from_json(json))

sus.dump(score: Score), sus.dumps(score: Score)

import sus

with open("score.sus", 'r') as fi, open(sus_file.with_suffix('.dumped.sus'), 'w') as fd:
    score = sus.load(fi)
    print(sus.dumps(score))
    sus.dump(score, fd, comment='Custom comment.', space=False)

Todo

• Acknowledgement
• Add example I/O
• Contribution Guide
• High Speed
• etc.

Links

Javascript

• sus-io (npm)
• sus-parse (npm)
• sus-stringify (npm)

License

MIT © 2021 mkpoli