meldtools 0.2.0

Tools used to work with MELD texts

Meldtools - investigating Middle English documents in Python

Meldtools is a package that allows you to conveniently search Middle English Local Documents corpus. It lets you query the corpus, slice it to easily-definable chunks and work with transcriptions, all in one place.

Setting up development environment

• Clone this repository and cd into it.

Python version manager

• Use a Python version manager of your choice.
• The recommended one to use is pyenv.
• Install Python ^3.8 with your version manager.

Python package manager

• Poetry is the package manager used in this project.
• Follow the installation guide on the website to install Poetry.
• Run poetry install so that Poetry can create a virtual envionment and install the packages into it.
• Poetry uses pyproject.toml, the new configuration file for Python laid out in PEP 517 and PEP 518.

Testing

To quickly run unit tests run the command like this

make test

Or if you want a full coverage report

make ctest

Check for type hints by running

make mypy

Running the command-line program

In order to run the program key in the following:

poetry run meldtools jsonify -d dir/with/rec/files -r path/to/register/csv -

The program works the Unix way, and it accepts a file or - as a special file that refers to stdout.

poetry run meldtools jsonify -d dir/with/rec/files -r path/to/register/csv -

# OR

poetry run meldtools jsonify -d dir/with/rec/files -r path/to/register/csv out.json

You can direct stdout to a file by appending > meld.json to the previous command. You can also pipe stdout directly to jq, for example, poetry run vl-lingo jsonify -d dir/with/rec/files -r /path/to/register/csv - | jq.