Skip to main content

Set of Python tools for the RATOM project

Project description

Logo

libratom

PyPI version Build Status codecov Codacy Badge

Python library and supporting utilities to parse and process PST and MBOX email sources.

This project is under development

Installation

Libratom requires Python 3.6 or newer, and can be installed via the Python Package Index (PyPI). Installing via pip will automatically install all required dependencies.

To install and test this software in a new Python virtual environment in Ubuntu 16.04LTS or newer:

Make sure Python 3.6 or newer, python3-pip, and python3-venv are installed:

sudo apt install python3 python3-pip python3-venv

Create and activate a Python virtual environment:

python3 -m venv venv
source venv/bin/activate

Make sure pip is upgraded to the latest version:

pip install --upgrade pip

Install libratom:

pip install libratom

Entity extraction

Libratom provides a CLI with planned support for a range of email processing tasks. Currently, the CLI supports entity extraction from individual PST files and directories of PST files.

To see available commands, type:

(venv) user@host:~$ ratom -h

To see detailed help for the entity extraction command, type:

(venv) user@host:~$ ratom entities -h

To run the extractor with default settings over a PST file or directory of PST files, type the following:

(venv) user@host:~$ ratom entities -p /path/to/PST-file-or-directory

Progress is displayed in a bar at the bottom of the window. To terminate a job early and shut down all workers, type Ctrl-C.

By default, the tool will use the spaCy en_core_web_sm model, and will start as many concurrent jobs as there are virtual cores available. Entities are written to a sqlite3 file automatically named using the existing file or directory name and current datetime stamp, and with the following single-table schema:

sqlite> .schema
CREATE TABLE entities (
	id INTEGER NOT NULL, 
	text VARCHAR, 
	label_ VARCHAR, 
	filename VARCHAR, 
	message_id INTEGER, 
	PRIMARY KEY (id)
);

In this schema, id is the primary key, text is the entity instance, label_ is the entity type, filename is the PST file associated with this message and entity instance, message_id is the PST-internal identifier for the message.

Additional libratom use cases

More usage documentation will appear here as the project matures. For now, you can try out some of the functionality in Jupyter notebooks we've prepared at:

https://github.com/libratom/ratom-notebooks

License(s)

Logos, documentation, and other non-software products of the RATOM team are distributed under the terms of Creative Commons 4.0 Attribution. Software items in RATOM repositories are distributed under the terms of the MIT License. See the LICENSE file for additional details.

© 2019, The University of North Carolina at Chapel Hill.

Development Team and Support

Developed by the RATOM team at the University of North Carolina at Chapel Hill.

See https://ratom.web.unc.edu for additional project details, staff bios, and news.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

libratom-0.1.2.dev23.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

libratom-0.1.2.dev23-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file libratom-0.1.2.dev23.tar.gz.

File metadata

  • Download URL: libratom-0.1.2.dev23.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

File hashes

Hashes for libratom-0.1.2.dev23.tar.gz
Algorithm Hash digest
SHA256 cec4a8d35333435476eb1f184e4bb69867072d279a1c36d643f09d12eb9652bb
MD5 bd1d961cad7d96d1963e0a94bc6dd92a
BLAKE2b-256 514081c4a72c74ce92ebcb1383e73a2eb81ddf8f7d7b9ea88fe6f1b822212f37

See more details on using hashes here.

File details

Details for the file libratom-0.1.2.dev23-py3-none-any.whl.

File metadata

  • Download URL: libratom-0.1.2.dev23-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

File hashes

Hashes for libratom-0.1.2.dev23-py3-none-any.whl
Algorithm Hash digest
SHA256 b849fc44c0b7ea045b88b998003b81f156cf5c8e7cd9cc967155ea12de0a3640
MD5 7dcce5945a3ddb6d8d9be298689ec06f
BLAKE2b-256 1fb2255f18bfaf24f799fc1da332889e1339d314d4b590cf3c7254a7697a9721

See more details on using hashes here.

Supported by

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