Welcome to ISLEX named-entities entries documentation!

Contents:

ISLE pronunciation dictionary named-entity entries

Documentation Status Updates

Data package containing named-entities of the ISLE dictionary (those labeled as exclusively named-entity (NNP or NNPS).

Features

  • Named entities from the ISLE dictionary (those that are exclusively NNP or NNPS).
  • See also the islex-core (for other parts-of-speech) and the remainder unlabeled in islex-periphery.

Credits

Package author is Jeremy G Kahn, repackaging the very useful ISLE pronunciation lexicon from the Illinois Speech and Language Engineering group.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install ISLEX pronunciation dictionary named-entities entries, run this command in your terminal:

$ pip install islex-entities

This is the preferred method to install the named-entity entries, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for ISLEX pronunciation dictionary named-entity entries can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/jkahn/islex-entities

Or download the tarball:

$ curl  -OL https://github.com/jkahn/islex-entities/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py bdist_wheel
$ pip install -U dist/*.whl

Release checklist

Update HISTORY.rst with release notes for upcoming release. Commit to master.

Check that everything still works:

$ make test-all

Update the version number:

$ bumpversion patch  # or minor, or major?

Make sure everything still works:

$ make test-all

Push the version bump and its tag up to the repo:

$ git push; git push --tags

Expect (if you’re Jeremy) that travis will push the wheel to pypi.

Edit the release on Github (e.g. https://github.com/jkahn/islex/releases). Paste release notes into the release’s release page, and come up with a title for the release.

Usage

To use ISLEX pronunciation dictionary accessors in a project:

from islex.data.entities import entries_stream

which provides a streaming iterator over the entries provided here.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/jkahn/islex-entities/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

These datasets could always use more documentation, whether as part of the official islex docs, in docstrings, or even on the web in blog posts, articles, and such. Please consider adding documentation for islex directly.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/jkahn/islex-entities/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up islex for local development.

  1. Fork the islex repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/islex-entities.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv islex-entities
$ cd islex-entities/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 islex-entities tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/jkahn/islex-entities/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_islex

Roadmap

No additional work except perhaps cleaning up a few entries here.

Credits

Development Lead

Contributors

Data sourced from the ISLE project lexicon.

History

0.1.2 (27 July 2017)

  • Changed classifier to upgrade to Alpha status, and because bad merge made tag v0.1.1 misalign git repo with pypi.

0.1.1 (27 July 2017)

  • Patched documentation to remove some leftovers from port over from islex-core.

0.1.0 (26 July 2016)

  • First git checkin of named-entity ISLE data, with configuration managed upstream.
  • deployed with automatic push to pypi by travis.