Features¶

• Loading and navigating around the data structures of the ISLE lexicon.

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.

Stable release¶

To install ISLEX pronunciation dictionary accessors, run this command in your terminal:

$ pip install islex

This is the preferred method to install ISLEX pronunciation dictionary accessors, as it will always install the most recent stable release.

This package is tested for support on Python 2.7+, Python 3.4+, and current PyPy.

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 accessors can be downloaded from the Github repo.

You can either clone the public repository:

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

Or download the tarball:

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

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

$ python setup.py install

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.

Types of Contributions¶

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.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
   $ cd islex/
   $ 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 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/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

Next up¶

• Include clean, indexed dictionary in package.

Wishlist¶

• Depend on attr module instead of namedtuple.

Improvements to automation¶

• get coverage automation through travis.
• cherrypick tweaks to template out to separate package-automation branch
• Port package-automation into a cookiecutter-pypackage fork.

/

Development Lead¶

• Jeremy G. Kahn <jeremy@trochee.net>

Contributors¶

None yet. Why not be the first?

0.2.2 (2016-08-28)¶

• Support read-only lazy loading of case-insensitive mappings from orthography.
• Docs fixes.

0.2.1 (2016-07-26)¶

• Mark as zip-safe.
• Correct some loading code to work better for subpackages.

0.2.0 (2016-07-26)¶

• Constructs islex.data namespace for other packages to land in.
• Improved handling of morphologically-analyzed words.
• Include behaviors to restore to strings.
• Include functions to write to external files for managing data as subpackages.
• codecov support

0.1.2 (2016-07-20)¶

• (intended difference with : release to PyPI done by Travis.)
• Refactor to use attrs classes for clean, fast types.

0.1.1 (2016-07-12)¶

• released on pypi (without this note).
• added several tweaks and tuning towards coverage with pytest

0.1.0 (2016-07-12)¶

• First release on PyPI.
• Supported Travis-CI, islex.readthedocs.org, and pyup-ci.org