Metadata-Version: 2.1
Name: pylexibank
Version: 0.1.0
Summary: Python library implementing the lexibank workbench
Home-page: https://github.com/lexibank/pylexibank
Author: Robert Forkel
Author-email: forkel@shh.mpg.de
License: Apache 2.0
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
Requires-Dist: six
Requires-Dist: attr
Requires-Dist: pycldf
Requires-Dist: clldutils
Requires-Dist: pyglottolog
Requires-Dist: pyconcepticon
Requires-Dist: pyclpa
Requires-Dist: segments
Requires-Dist: lingpy
Requires-Dist: appdirs
Requires-Dist: requests
Requires-Dist: termcolor
Requires-Dist: gitpython
Requires-Dist: tqdm
Requires-Dist: xlrd
Requires-Dist: goodtables
Requires-Dist: prompt-toolkit (~=1.0)
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: test
Requires-Dist: mock; extra == 'test'
Requires-Dist: pytest (>=3.1); extra == 'test'
Requires-Dist: pytest-mock; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: coverage (>=4.2); extra == 'test'

# pylexibank

[![Build Status](https://travis-ci.org/lexibank/pylexibank.png)](https://travis-ci.org/lexibank/pylexibank)
[![codecov](https://codecov.io/gh/lexibank/pylexibank/branch/master/graph/badge.svg)](https://codecov.io/gh/lexibank/pylexibank)
[![Requirements Status](https://requires.io/github/lexibank/pylexibank/requirements.svg?branch=master)](https://requires.io/github/lexibank/pylexibank/requirements/?branch=master)
[![PyPI](https://img.shields.io/pypi/v/pylexibank.svg)](https://pypi.org/pypi/pylexibank)


## Install

Since `pylexibank` has quite a few dependencies, installing it will result in installing
many other python packages along with it. To avoid any side effects for your default
python installation, we recommend installation in a
[virtual environment](https://virtualenv.pypa.io/en/stable/).

Some code of `pylexibank` relies on LingPy functionality which is not yet released, thus,
LingPy should be installed from the source repository, running
```
$ git clone https://github.com/lingpy/lingpy/
$ cd lingpy
$ python setup.py install
```

Now you may install `pylexibank` via pip or in development mode following the instructions
in [CONTRIBUTING.md](CONTRIBUTING.md).

Some functionality in `pylexibank` (in particular the `install` sub-command), require access
to [Glottolog](http://glottolog.org) or [Concepticon](http://concepticon.pylexibank.org) data.
Since the data of both these applications is curated in git repositories as well, the easiest
way to achieve this is by cloning [pylexibank/glottolog](https://github.com/pylexibank/glottolog) and
[pylexibank/concepticon-data](https://github.com/pylexibank/concepticon). But you could also download
(and unpack) a released version of these repositories.


## Usage

`pylexibank` can be used in two ways:
- The command line interface provides mainly access to the functionality for the `lexibank`
  [curation workflow](workflow.md).
- The `pylexibank` package can also be used like any other python package in your own
  python code to access lexibank data in a programmatic (and consistent) way.



