CLiCTagger Region-tagging

Python module to identify regions in text.

Part of the CLiC project

Installation

Linux

First make sure you have the following prerequisites installed:

apt-get install python3 python3-dev \
    libicu-dev pkg-config

Then install via. pip:

pip install clictagger

Windows / MacOS

Under either you can install clictagger via. Anaconda:

1. Install Miniconda if you haven't already.
2. Download environment-windows.yml if running windows, environment.yml otherwise.
3. Start an Anaconda prompt
4. On windows, run conda env create -f environment-windows.yml, otherwise run conda env create -f environment.yml
5. conda activate clictagger

You can now use clictagger.

Usage

Python notebook

See getting_started.ipynb.

To region-tag your own examples, use file-upload.ipynb

Command line

You should now have the clictagger command available. See --help for usage.

For more examples, see the clictagger.script documentation.

Development

There is a Makefile that will setup and perform common development actions, in a venv. Once code is checked out you can run:

make test  # Run all tests
make lint  # Check code formatting
make coverage  # Check unit-test coverage
make notebook  # Install and serve a Jupyter notebook session
make release  # Use zest.releaser to make a new release

Acknowledgements

This work is released under MIT.