Metadata-Version: 2.0
Name: ety
Version: 1.0.0
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
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: treelib
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'

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

[![Build Status](https://travis-ci.org/jmsv/ety-python.svg?branch=master)](https://travis-ci.org/jmsv/ety-python)
[![PyPI version](https://badge.fury.io/py/ety.svg)](https://badge.fury.io/py/ety)
[![Python versions](https://img.shields.io/pypi/pyversions/ety.svg)](https://pypi.python.org/pypi/ety)
[![Wheel Support](https://img.shields.io/pypi/wheel/ety.svg)](https://pypi.python.org/pypi/ety)

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

## Install

### [pip](https://pypi.org/project/ety)

```bash
pip install ety
```

### Development

```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
```

## Changelog

### [1.0.0] - 2018/05/23

#### Added
- `ety.tree` method takes a word and outputs the word's etymology in a tree format

#### Changed
- Uses [Etymological Wordnet](http://www1.icsi.berkeley.edu/~demelo/etymwn) data instead of scraped Dictionary.com data
- `ety.origins` output structure changed

### [0.2.0] - 2018/05/16
#### Added
- `ety.words` method. This acts as a reverse search: given an origin, it will return all of the words from (or partially from) that origin
- `ety.random_word` method returns a random word from the origins data set

### [0.1.0] - 2018/05/15
- `ety.origins` method takes a word and returns a list of the etymological origins of the word
- Command line tool: `ety word` lists the origins of 'word'

## Roadmap
- Support analysis of large amounts of text/files e.g. books


