Skip to main content

A python library for extracting parts from sheetmusic pdfs

Project description

sheatless - A python library for extracting parts from sheetmusic pdfs

Sheatless, a tool for The Beatless to become sheetless. Written and managed by the web-committee in the student orchestra The Beatless. Soon to be integrated in taktlaus.no.

API

processUploadedPdf

def processUploadedPdf(pdfPath, imagesDirPath, instruments_file=None, instruments=None, use_lstm=False, tessdata_dir=None):
    ...
	return parts, instrumentsDefaultParts

which will be available with

from sheatless import processUploadedPdf

Arguments description here:

Argument Optional Description
pdfPath Full path to PDF file.
imagesDirPath Full path to output images.
instruments_file (optional) Full path to instruments file. Accepted formats: YAML (.yaml, .yml), JSON (.json).
instruments (optional) Dictionary of instruments. Will override any provided instruments file.
If neither instruments_file nor instruments is provided a default instruments file will be used.
use_lstm (optional) Use LSTM instead of legacy engine mode.
tessdata_dir (optional) Full path to tessdata directory. If not provided, whatever the environment variable TESSDATA_DIR will be used.

Returns description here:

Return Description
parts A list of dictionaries { "name": "[name]", "fromPage": i, "toPage": j } describing each part
instrumentsDefaultParts A dictionary { ..., "instrument_i": j, ... }, where j is the index in the parts list for the default part for instrument_i.

predict_parts_in_pdf

def predict_parts_in_pdf(
	pdf : BytesIO | bytes,
	instruments=None,
	instruments_file=None,
	instruments_file_format="yaml",
	use_lstm=False,
	tessdata_dir=None,
	):
    ...
    return parts, instrumentsDefaultParts

Arguments:

  • pdf - PDF file object
  • instruments (optional) - Dictionary of instruments. Will override any provided instruments file.
  • instruments_file (optional) - Full path to instruments file or instruments file object. Accepted extensions: .yaml, .yml, .json
  • instruments_file_format (optional) - Format of instruments_file if it is a file object. Accepted formats: yaml, json
    • If neither instruments_file nor instruments is provided a default instruments file will be used.
  • use_lstm (optional) - Use LSTM instead of legacy engine mode.
  • tessdata_dir (optional) - Full path to tessdata directory. If not provided, whatever the environment variable TESSDATA_DIR will be used.

Returns:

  • parts - A list of dictionaries { "name": "[name]", "fromPage": i, "toPage": j } describing each part
  • instrumentsDefaultParts - A dictionary { ..., "instrument_i": j, ... }, where j is the index in the parts list for the default part for instrument_i.

predict_parts_in_img

def predict_parts_in_img(img : io.BytesIO | bytes | PIL.Image.Image, instruments, use_lstm=False, tessdata_dir=None) -> typing.Tuple[list, list]:
    ...
    return partNames, instrumentses

Arguments:

  • img - image object
  • instruments - dictionary of instruments
  • use_lstm (optional) - Use LSTM instead of legacy engine mode.
  • tessdata_dir (optional) - Full path to tessdata directory. If not provided, whatever the environment variable TESSDATA_DIR will be used.

Returns:

  • partNames - a list of part names
  • instrumentses - a list of lists of instruments for each part

Example docker setup

Sheatless requires tesseract and poppler installed on the system to work. An example docker setup as well as integration of the library can be found in sheatless-splitter.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sheatless-1.0.1.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

sheatless-1.0.1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file sheatless-1.0.1.tar.gz.

File metadata

  • Download URL: sheatless-1.0.1.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for sheatless-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a2d986001c8247f2f5865abdc7eccfb1ad0c0aeb8d8d29d392cee1a1ba07d501
MD5 4b9dea1b2e0f21c64a417497fccd604a
BLAKE2b-256 c6bedc8f4738b1f0df823baca6e8052b08c3b7ac5d48a7fc26ef4952a0a0c761

See more details on using hashes here.

File details

Details for the file sheatless-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: sheatless-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for sheatless-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec70190905206cbe743b71f697ea99abfdd03ae34fd663eafb4881d6753e7087
MD5 dbb104ca44472c0d0535686d18d7fb48
BLAKE2b-256 60011635ddab95347dc1f234c09f4d215c5a42ba9f4f82fe4446bf2454a2c857

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page