Metadata-Version: 2.1
Name: unboxer
Version: 0.0.2
Summary: Extract shoebox and toolbox data to CSV files.
Home-page: https://github.com/fmatter/unboxer
Author: Florian Matter
Author-email: florianmatter@gmail.com
Project-URL: Bug Tracker, https://github.com/fmatter/unboxer/issues
Keywords: shoebox,toolbox
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorlog
Requires-Dist: click
Requires-Dist: pandas (>=1.3.5)
Requires-Dist: python-slugify (>=6.1.2)
Requires-Dist: cldfbench (>=1.13.0)
Requires-Dist: pycldf (>=1.29.0)
Requires-Dist: importlib-resources (>=5.10.0)
Requires-Dist: humidifier
Requires-Dist: cldf-ldd
Requires-Dist: morphinder
Provides-Extra: dev
Requires-Dist: bump2version ; extra == 'dev'
Requires-Dist: coverage[toml] ; extra == 'dev'
Requires-Dist: prospector[with_pyroma] (==1.7.6) ; extra == 'dev'
Requires-Dist: pylint (==2.14.1) ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-autoapi ; extra == 'dev'
Requires-Dist: sphinxcontrib-napoleon ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: myst-parser ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: jinja2 ; extra == 'dev'
Requires-Dist: keepachangelog ; extra == 'dev'
Provides-Extra: publishing
Requires-Dist: twine ; extra == 'publishing'
Requires-Dist: wheel ; extra == 'publishing'

# unboxer

Extract data from shoebox and toolbox projects to CSV files.

![License](https://img.shields.io/github/license/fmatter/unboxer)
[![Tests](https://img.shields.io/github/actions/workflow/status/fmatter/unboxer/tests.yml?label=tests&branch=main)](https://github.com/fmatter/unboxer/actions/workflows/tests.yml)
[![Linting](https://img.shields.io/github/actions/workflow/status/fmatter/unboxer/lint.yml?label=linting&branch=main)](https://github.com/fmatter/unboxer/actions/workflows/lint.yml)
[![Codecov](https://img.shields.io/codecov/c/github/fmatter/unboxer)](https://app.codecov.io/gh/fmatter/unboxer/)
[![PyPI](https://img.shields.io/pypi/v/unboxer.svg)](https://pypi.org/project/unboxer)
![Versions](https://img.shields.io/pypi/pyversions/unboxer)

## Installation
```shell
pip install unboxer
```

## Usage
At the moment, there is only one command: `unbox corpus`, for collections of glossed texts.
To create a file `mytextdatabase.csv` from a toolbox file `mytextdatabase.txt`:

```shell
unbox corpus mytoolbox/mytextdatabase.txt
```

Project-specific configuration can be passed via `--conf your/config.yaml`; to see what options are available, check [the default configuration file](src/unboxer/data/interlinear_config.yaml) as well as the default configuration files for [toolbox](src/unboxer/data/toolbox.yaml) and [shoebox](src/unboxer/data/shoebox.yaml).

To create a [CLDF](cldf.clld.org/) version of the corpus, add the option `--cldf`.
For more help on how to run the command, use `unbox corpus --help`.

## Problems
1. if running `unbox` produces warnings, check your database for possible inconsistencies
2. if that did not solve your problem, [open an issue](https://github.com/fmatter/unboxer/issues/new)
