Metadata-Version: 2.0
Name: ety
Version: 0.1.0a1
Summary: find the etymological origins of a word
Home-page: https://github.com/jmsv/ety-python
Author: James Vickery
Author-email: dev@jamesvickery.net
License: UNKNOWN
Project-URL: Source, https://github.com/jmsv/ety-python
Project-URL: Bug Reports, https://github.com/jmsv/ety-python/issues
Keywords: etymology origins english language words
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
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
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'

# ety-python
Python module to find the etymological origins of a word

> ___Note:__ this module is under construction and doesn't yet have a large enough dataset to be useful_

## Install

```bash
pipenv shell
python setup.py install
```

## Usage

### Module

```
>>> import ety

>>> ety.origins("potato")
['Spanish', 'Taino']

>>> ety.origins("abandon")
['Middle English', 'Middle French', 'Old French']
```

### CLI

After installing, a command-line tool is also available

```
Usage:
  $ ety <word>

Example:
  $ ety potato
  Spanish, Taino
```

#### How it works

_(for reference)_

In `setup.py`, the following few lines tell `setuptools` to set up a cli script called '`ety`' that runs the `cli` method from the `ety` module.

```python
entry_points={
    'console_scripts': [
        'ety=ety:cli',
    ],
},
```

The `cli` method reads in the word as an argument. If no word is specified, the usage instructions and example are displayed


