Metadata-Version: 2.1
Name: pypofatu
Version: 1.6.0
Summary: programmatic access to pofatu-data
Home-page: https://github.com/pofatu/pypofatu
Author: Robert Forkel
Author-email: robert_forkel@eva.mpg.de
License: Apache 2.0
Keywords: data
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE

# pypofatu

A python package to curate [Pofatu data](https://github.com/pofatu/pofatu-data).

[![Build Status](https://github.com/pofatu/pypofatu/workflows/tests/badge.svg)](https://github.com/pofatu/pypofatu/actions?query=workflow%3Atests)
[![PyPI](https://img.shields.io/pypi/v/pypofatu.svg)](https://pypi.org/project/pypofatu)


## Installation

Install `pypofatu` from [PyPI](https://pypi.org) running
```shell script
pip install pypofatu
```
preferably in a new [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/), to keep your system's Python installation unaffected.

Installing `pypofatu` will also install a command line program `pofatu`, which provides
functionality to curate and query Pofatu data. Run
```shell script
pofatu -h
```
for details on usage.

`pypofatu` operates on data of the [Pofatu database](https://pofatu.clld.org). This
data is accessed locally. Thus, in order to use `pypofatu` you must clone the
[`pofatu/pofatu-data`](https://github.com/pofatu/pofatu-data) repository or download
a [release version](https://github.com/pofatu/pofatu-data/releases).
