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.